Skip to content

Commit

Permalink
docs: add documentation for find
Browse files Browse the repository at this point in the history
Co-authored-by: Matt <[email protected]>
  • Loading branch information
SlayerOrnstein and TobiTenno authored Sep 27, 2024
1 parent 1e0244b commit 162a049
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/Utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ const categories = [
'Pets',
];

/**
* Find an item by Item#uniqueName
* @param {string} name string with which to query
* @param {string} [locale='en'] locale to use for internationalization
* @returns {Item}
*/
export const find = (name, locale = 'en') => {
const items = new Items({
category: categories,
Expand Down

0 comments on commit 162a049

Please sign in to comment.