fix: README example errors and comment grammar

jacob-shuman · Sep 24, 2024 · be3c3fc · be3c3fc
1 parent 05e8535
commit be3c3fc
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -47,7 +47,7 @@ interface ItunesResults {
   collectionId?: number;
   trackId?: number;
   artistName?: string;
-  collectionName: string;
+  collectionName?: string;
   trackName?: string;
   collectionCensoredName?: string;
   trackCensoredName?: string;
@@ -122,7 +122,7 @@ const results = await searchItunes({
   term: "Queen Bohemian Rhapsody",
 
   // Setting max number of results to 2
-  limit: 2,
+  limit: "2",
 });
 
 console.log(results);

diff --git a/src/lookup.ts b/src/lookup.ts
@@ -1,7 +1,7 @@
 import type { ItunesEntities, ItunesResults } from "./mod";
 
 /**
- * Known lookup params
+ * Known lookup parameters
  */
 export type ItunesLookupOptions = {
   /**

diff --git a/src/search.ts b/src/search.ts
@@ -5,7 +5,7 @@ import type {
 } from "./mod";
 
 /**
- * Known search params
+ * Known search parameters
  */
 export type ItunesSearchOptions = {
   /**