Skip to content

fix: updating jsDocs for understanding publicApiKey usage #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jaredwray wants to merge 1 commit into from
Closed

fix: updating jsDocs for understanding publicApiKey usage #123

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/hyphen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,21 @@ export type HyphenOptions = {
apiKey?: string;
/**
* Options for the Toggle service.
* Excludes `publicApiKey` as it's provided at the top level.
Copy link

@gemini-code-assist gemini-code-assist bot Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The phrasing Excludes... is a bit awkward as a sentence fragment. To improve clarity and remove the ambiguity of 'top level', I suggest rephrasing to directly state where the publicApiKey should be provided.

Suggested change
* Excludes `publicApiKey` as it's provided at the top level.
* `publicApiKey` is provided on the top-level `HyphenOptions` object.

* @see ToggleOptions
* @default {Toggle}
*/
toggle?: Omit<ToggleOptions, "publicApiKey">;
/**
* Options for the NetInfo service.
* Excludes `apiKey` as it's provided at the top level.
Copy link

@gemini-code-assist gemini-code-assist bot Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The phrasing Excludes... is a bit awkward as a sentence fragment. To improve clarity and remove the ambiguity of 'top level', I suggest rephrasing to directly state where the apiKey should be provided.

Suggested change
* Excludes `apiKey` as it's provided at the top level.
* `apiKey` is provided on the top-level `HyphenOptions` object.

* @see NetInfoOptions
* @default {NetInfo}
*/
netInfo?: Omit<NetInfoOptions, "apiKey">;
/**
* Options for the Link service.
* Excludes `apiKey` as it's provided at the top level.
Copy link

@gemini-code-assist gemini-code-assist bot Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The phrasing Excludes... is a bit awkward as a sentence fragment. To improve clarity and remove the ambiguity of 'top level', I suggest rephrasing to directly state where the apiKey should be provided.

Suggested change
* Excludes `apiKey` as it's provided at the top level.
* `apiKey` is provided on the top-level `HyphenOptions` object.

* @see LinkOptions
* @default {Link}
*/
Expand Down
Loading