From be3c3fc43e947e69d27f2ba2b8113405d6c00f97 Mon Sep 17 00:00:00 2001 From: Jacob Shuman <44483276+jacob-shuman@users.noreply.github.com> Date: Tue, 24 Sep 2024 17:41:06 -0400 Subject: [PATCH] fix: README example errors and comment grammar --- README.md | 4 ++-- src/lookup.ts | 2 +- src/search.ts | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bbfbb84..dd97bf5 100644 --- 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 index e1d1dbf..fb5d8f3 100644 --- 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 index 119d424..8883f5d 100644 --- 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 = { /**