Skip to content

C
Chatgpt Puppeteer
Commit 75c4e3e0 authored by Travis Fischer's avatar Travis Fischer
Browse files
Options

chore: update ts docs

parent d1b74a87
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 95 additions and 68 deletions
docs/classes/AChatGPTAPI.md
View file @ 75c4e3e0
......@@ -49,7 +49,7 @@ An error if it fails.
#### Defined in
[src/abstract-chatgpt-api.ts:69](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/abstract-chatgpt-api.ts#L69)
[src/abstract-chatgpt-api.ts:69](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/abstract-chatgpt-api.ts#L69)
___
......@@ -66,7 +66,7 @@ otherwise.
#### Defined in
[src/abstract-chatgpt-api.ts:39](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/abstract-chatgpt-api.ts#L39)
[src/abstract-chatgpt-api.ts:39](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/abstract-chatgpt-api.ts#L39)
___
......@@ -87,7 +87,7 @@ An error if the session failed to initialize properly.
#### Defined in
[src/abstract-chatgpt-api.ts:10](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/abstract-chatgpt-api.ts#L10)
[src/abstract-chatgpt-api.ts:10](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/abstract-chatgpt-api.ts#L10)
___
......@@ -111,7 +111,7 @@ Access credentials for the new session.
#### Defined in
[src/abstract-chatgpt-api.ts:49](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/abstract-chatgpt-api.ts#L49)
[src/abstract-chatgpt-api.ts:49](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/abstract-chatgpt-api.ts#L49)
___
......@@ -135,7 +135,7 @@ Access credentials for the new session.
#### Defined in
[src/abstract-chatgpt-api.ts:59](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/abstract-chatgpt-api.ts#L59)
[src/abstract-chatgpt-api.ts:59](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/abstract-chatgpt-api.ts#L59)
___
......@@ -164,4 +164,4 @@ the `response` text.
#### Defined in
[src/abstract-chatgpt-api.ts:30](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/abstract-chatgpt-api.ts#L30)
[src/abstract-chatgpt-api.ts:30](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/abstract-chatgpt-api.ts#L30)
docs/classes/ChatGPTAPI.md
View file @ 75c4e3e0
......@@ -64,7 +64,7 @@ to obtain your `clearanceToken`.
#### Defined in
[src/chatgpt-api.ts:45](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api.ts#L45)
[src/chatgpt-api.ts:45](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api.ts#L45)
## Accessors
......@@ -80,7 +80,7 @@ Gets the current Cloudflare clearance token (`cf_clearance` cookie value).
#### Defined in
[src/chatgpt-api.ts:143](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api.ts#L143)
[src/chatgpt-api.ts:143](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api.ts#L143)
___
......@@ -96,7 +96,7 @@ Gets the current session token.
#### Defined in
[src/chatgpt-api.ts:138](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api.ts#L138)
[src/chatgpt-api.ts:138](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api.ts#L138)
___
......@@ -112,7 +112,7 @@ Gets the currently signed-in user, if authenticated, `null` otherwise.
#### Defined in
[src/chatgpt-api.ts:133](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api.ts#L133)
[src/chatgpt-api.ts:133](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api.ts#L133)
___
......@@ -128,7 +128,7 @@ Gets the current user agent.
#### Defined in
[src/chatgpt-api.ts:148](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api.ts#L148)
[src/chatgpt-api.ts:148](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api.ts#L148)
## Methods
......@@ -152,7 +152,7 @@ An error if it fails.
#### Defined in
[src/chatgpt-api.ts:470](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api.ts#L470)
[src/chatgpt-api.ts:470](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api.ts#L470)
___
......@@ -173,7 +173,7 @@ the token fails.
#### Defined in
[src/chatgpt-api.ts:367](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api.ts#L367)
[src/chatgpt-api.ts:367](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api.ts#L367)
___
......@@ -194,7 +194,7 @@ is valid.
#### Defined in
[src/chatgpt-api.ts:156](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api.ts#L156)
[src/chatgpt-api.ts:156](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api.ts#L156)
___
......@@ -224,7 +224,7 @@ A valid access token
#### Defined in
[src/chatgpt-api.ts:386](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api.ts#L386)
[src/chatgpt-api.ts:386](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api.ts#L386)
___
......@@ -252,7 +252,7 @@ Access credentials for the new session.
#### Defined in
[src/abstract-chatgpt-api.ts:59](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/abstract-chatgpt-api.ts#L59)
[src/abstract-chatgpt-api.ts:59](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/abstract-chatgpt-api.ts#L59)
___
......@@ -287,7 +287,7 @@ The response from ChatGPT
#### Defined in
[src/chatgpt-api.ts:180](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api.ts#L180)
[src/chatgpt-api.ts:180](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api.ts#L180)
___
......@@ -307,4 +307,4 @@ ___
#### Defined in
[src/chatgpt-api.ts:324](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api.ts#L324)
[src/chatgpt-api.ts:324](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api.ts#L324)
docs/classes/ChatGPTAPIBrowser.md
View file @ 75c4e3e0
......@@ -60,7 +60,7 @@ Creates a new client for automating the ChatGPT webapp.
#### Defined in
[src/chatgpt-api-browser.ts:38](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api-browser.ts#L38)
[src/chatgpt-api-browser.ts:38](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api-browser.ts#L38)
## Accessors
......@@ -74,7 +74,7 @@ Creates a new client for automating the ChatGPT webapp.
#### Defined in
[src/chatgpt-api-browser.ts:541](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api-browser.ts#L541)
[src/chatgpt-api-browser.ts:599](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api-browser.ts#L599)
## Methods
......@@ -94,7 +94,7 @@ Creates a new client for automating the ChatGPT webapp.
#### Defined in
[src/chatgpt-api-browser.ts:187](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api-browser.ts#L187)
[src/chatgpt-api-browser.ts:204](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api-browser.ts#L204)
___
......@@ -114,7 +114,7 @@ ___
#### Defined in
[src/chatgpt-api-browser.ts:224](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api-browser.ts#L224)
[src/chatgpt-api-browser.ts:241](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api-browser.ts#L241)
___
......@@ -138,7 +138,7 @@ An error if it fails.
#### Defined in
[src/chatgpt-api-browser.ts:526](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api-browser.ts#L526)
[src/chatgpt-api-browser.ts:574](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api-browser.ts#L574)
___
......@@ -159,7 +159,7 @@ otherwise.
#### Defined in
[src/chatgpt-api-browser.ts:316](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api-browser.ts#L316)
[src/chatgpt-api-browser.ts:335](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api-browser.ts#L335)
___
......@@ -184,7 +184,7 @@ An error if the session failed to initialize properly.
#### Defined in
[src/chatgpt-api-browser.ts:106](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api-browser.ts#L106)
[src/chatgpt-api-browser.ts:106](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api-browser.ts#L106)
___
......@@ -204,7 +204,7 @@ Attempts to handle 403 errors by refreshing the page.
#### Defined in
[src/chatgpt-api-browser.ts:296](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api-browser.ts#L296)
[src/chatgpt-api-browser.ts:313](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api-browser.ts#L313)
___
......@@ -224,7 +224,7 @@ Attempts to handle 401 errors by re-authenticating.
#### Defined in
[src/chatgpt-api-browser.ts:277](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api-browser.ts#L277)
[src/chatgpt-api-browser.ts:294](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api-browser.ts#L294)
___
......@@ -238,7 +238,7 @@ ___
#### Defined in
[src/chatgpt-api-browser.ts:518](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api-browser.ts#L518)
[src/chatgpt-api-browser.ts:566](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api-browser.ts#L566)
___
......@@ -271,4 +271,4 @@ the `response` text.
#### Defined in
[src/chatgpt-api-browser.ts:393](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/chatgpt-api-browser.ts#L393)
[src/chatgpt-api-browser.ts:412](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/chatgpt-api-browser.ts#L412)
docs/classes/ChatGPTError.md
View file @ 75c4e3e0
......@@ -66,7 +66,7 @@ node_modules/.pnpm/typescript@4.9.3/node_modules/typescript/lib/lib.es2022.error
#### Defined in
[src/types.ts:297](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/types.ts#L297)
[src/types.ts:297](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/types.ts#L297)
___
......@@ -76,7 +76,7 @@ ___
#### Defined in
[src/types.ts:296](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/types.ts#L296)
[src/types.ts:296](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/types.ts#L296)
___
......@@ -86,7 +86,7 @@ ___
#### Defined in
[src/types.ts:294](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/types.ts#L294)
[src/types.ts:294](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/types.ts#L294)
___
......@@ -96,4 +96,4 @@ ___
#### Defined in
[src/types.ts:295](https://github.com/transitive-bullshit/chatgpt-api/blob/7222b7f/src/types.ts#L295)
[src/types.ts:295](https://github.com/transitive-bullshit/chatgpt-api/blob/d1b74a8/src/types.ts#L295)
docs/modules.md
View file @ 75c4e3e0
This diff is collapsed.
docs/readme.md
View file @ 75c4e3e0
......@@ -350,6 +350,8 @@ All of these awesome projects are built using the `chatgpt` package. 🤯
- [Electron Bot](https://github.com/ShiranAbir/chaty)
- [Kodyfire CLI](https://github.com/nooqta/chatgpt-kodyfire)
- [Twitch Bot](https://github.com/BennyDeeDev/chatgpt-twitch-bot)
- [Continuous Conversation](https://github.com/DanielTerletzkiy/chat-gtp-assistant)
- [Figma plugin](https://github.com/frederickk/chatgpt-figma-plugin)
If you create a cool integration, feel free to open a PR and add it to the list.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment