Skip to content

Commit

Permalink
refactor: make readmeAPIKey private, move JSDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
kanadgupta committed Feb 1, 2024
1 parent 98a85a7 commit 6afcf7f
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions packages/node/src/lib/ReadMe.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,17 +63,17 @@ interface ReadMeVersion {
* @see {@link https://docs.readme.com/main/docs/unified-snippet-docs}
*/
export default class ReadMe {
/**
* The API key for your ReadMe project. This ensures your requests end up in
* your dashboard. You can read more about the API key in
* [our docs](https://docs.readme.com/reference/authentication).
*/
readmeAPIKey: string;
private readmeAPIKey: string;

private readmeProjectData!: GetProjectResponse200;

private readmeVersionData!: ReadMeVersion[];

/**
* @param key The API key for your ReadMe project. This ensures your requests end up in
* your dashboard. You can read more about the API key in
* [our docs](https://docs.readme.com/reference/authentication).
*/
constructor(key: string) {
this.readmeAPIKey = key;
}
Expand Down

0 comments on commit 6afcf7f

Please sign in to comment.