Skip to content

Commit a020bcc

Browse files
chore: update ts docs
1 parent fb06beb commit a020bcc

16 files changed

+153
-126
lines changed

docs/classes/ChatGPTAPI.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Creates a new client wrapper around OpenAI's chat completion API, mimicing the o
3333

3434
#### Defined in
3535

36-
[src/chatgpt-api.ts:51](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/chatgpt-api.ts#L51)
36+
[src/chatgpt-api.ts:51](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/chatgpt-api.ts#L51)
3737

3838
## Accessors
3939

@@ -47,7 +47,7 @@ Creates a new client wrapper around OpenAI's chat completion API, mimicing the o
4747

4848
#### Defined in
4949

50-
[src/chatgpt-api.ts:345](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/chatgpt-api.ts#L345)
50+
[src/chatgpt-api.ts:345](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/chatgpt-api.ts#L345)
5151

5252
`set` **apiKey**(`apiKey`): `void`
5353

@@ -63,7 +63,7 @@ Creates a new client wrapper around OpenAI's chat completion API, mimicing the o
6363

6464
#### Defined in
6565

66-
[src/chatgpt-api.ts:349](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/chatgpt-api.ts#L349)
66+
[src/chatgpt-api.ts:349](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/chatgpt-api.ts#L349)
6767

6868
___
6969

@@ -77,7 +77,7 @@ ___
7777

7878
#### Defined in
7979

80-
[src/chatgpt-api.ts:353](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/chatgpt-api.ts#L353)
80+
[src/chatgpt-api.ts:353](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/chatgpt-api.ts#L353)
8181

8282
`set` **apiOrg**(`apiOrg`): `void`
8383

@@ -93,7 +93,7 @@ ___
9393

9494
#### Defined in
9595

96-
[src/chatgpt-api.ts:357](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/chatgpt-api.ts#L357)
96+
[src/chatgpt-api.ts:357](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/chatgpt-api.ts#L357)
9797

9898
## Methods
9999

@@ -125,4 +125,4 @@ The response from ChatGPT
125125

126126
#### Defined in
127127

128-
[src/chatgpt-api.ts:137](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/chatgpt-api.ts#L137)
128+
[src/chatgpt-api.ts:137](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/chatgpt-api.ts#L137)

docs/classes/ChatGPTError.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Error.constructor
3939

4040
#### Defined in
4141

42-
node_modules/.pnpm/typescript@5.0.3/node_modules/typescript/lib/lib.es5.d.ts:1060
42+
node_modules/.pnpm/typescript@5.0.4/node_modules/typescript/lib/lib.es5.d.ts:1060
4343

4444
**new ChatGPTError**(`message?`, `options?`)
4545

@@ -56,7 +56,7 @@ Error.constructor
5656

5757
#### Defined in
5858

59-
node_modules/.pnpm/typescript@5.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:28
59+
node_modules/.pnpm/typescript@5.0.4/node_modules/typescript/lib/lib.es2022.error.d.ts:28
6060

6161
## Properties
6262

@@ -66,7 +66,7 @@ node_modules/.pnpm/typescript@5.0.3/node_modules/typescript/lib/lib.es2022.error
6666

6767
#### Defined in
6868

69-
[src/types.ts:86](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L86)
69+
[src/types.ts:86](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L86)
7070

7171
___
7272

@@ -76,7 +76,7 @@ ___
7676

7777
#### Defined in
7878

79-
[src/types.ts:85](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L85)
79+
[src/types.ts:85](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L85)
8080

8181
___
8282

@@ -86,7 +86,7 @@ ___
8686

8787
#### Defined in
8888

89-
[src/types.ts:83](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L83)
89+
[src/types.ts:83](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L83)
9090

9191
___
9292

@@ -96,4 +96,4 @@ ___
9696

9797
#### Defined in
9898

99-
[src/types.ts:84](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L84)
99+
[src/types.ts:84](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L84)

docs/classes/ChatGPTUnofficialProxyAPI.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636

3737
#### Defined in
3838

39-
[src/chatgpt-unofficial-proxy-api.ts:20](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/chatgpt-unofficial-proxy-api.ts#L20)
39+
[src/chatgpt-unofficial-proxy-api.ts:20](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/chatgpt-unofficial-proxy-api.ts#L20)
4040

4141
## Accessors
4242

@@ -50,7 +50,7 @@
5050

5151
#### Defined in
5252

53-
[src/chatgpt-unofficial-proxy-api.ts:66](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/chatgpt-unofficial-proxy-api.ts#L66)
53+
[src/chatgpt-unofficial-proxy-api.ts:66](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/chatgpt-unofficial-proxy-api.ts#L66)
5454

5555
`set` **accessToken**(`value`): `void`
5656

@@ -66,7 +66,7 @@
6666

6767
#### Defined in
6868

69-
[src/chatgpt-unofficial-proxy-api.ts:70](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/chatgpt-unofficial-proxy-api.ts#L70)
69+
[src/chatgpt-unofficial-proxy-api.ts:70](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/chatgpt-unofficial-proxy-api.ts#L70)
7070

7171
## Methods
7272

@@ -101,4 +101,4 @@ The response from ChatGPT
101101

102102
#### Defined in
103103

104-
[src/chatgpt-unofficial-proxy-api.ts:97](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/chatgpt-unofficial-proxy-api.ts#L97)
104+
[src/chatgpt-unofficial-proxy-api.ts:97](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/chatgpt-unofficial-proxy-api.ts#L97)

docs/interfaces/ChatMessage.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
#### Defined in
2525

26-
[src/types.ts:79](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L79)
26+
[src/types.ts:79](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L79)
2727

2828
___
2929

@@ -33,7 +33,7 @@ ___
3333

3434
#### Defined in
3535

36-
[src/types.ts:70](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L70)
36+
[src/types.ts:70](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L70)
3737

3838
___
3939

@@ -43,7 +43,7 @@ ___
4343

4444
#### Defined in
4545

46-
[src/types.ts:71](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L71)
46+
[src/types.ts:71](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L71)
4747

4848
___
4949

@@ -53,7 +53,7 @@ ___
5353

5454
#### Defined in
5555

56-
[src/types.ts:66](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L66)
56+
[src/types.ts:66](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L66)
5757

5858
___
5959

@@ -63,7 +63,7 @@ ___
6363

6464
#### Defined in
6565

66-
[src/types.ts:69](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L69)
66+
[src/types.ts:69](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L69)
6767

6868
___
6969

@@ -73,7 +73,7 @@ ___
7373

7474
#### Defined in
7575

76-
[src/types.ts:76](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L76)
76+
[src/types.ts:76](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L76)
7777

7878
___
7979

@@ -83,7 +83,7 @@ ___
8383

8484
#### Defined in
8585

86-
[src/types.ts:68](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L68)
86+
[src/types.ts:68](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L68)
8787

8888
___
8989

@@ -93,4 +93,4 @@ ___
9393

9494
#### Defined in
9595

96-
[src/types.ts:67](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L67)
96+
[src/types.ts:67](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L67)

docs/interfaces/CreateChatCompletionStreamResponse.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131

3232
#### Defined in
3333

34-
[src/types.ts:198](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L198)
34+
[src/types.ts:198](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L198)
3535

3636
___
3737

@@ -45,7 +45,7 @@ ___
4545

4646
#### Defined in
4747

48-
[src/types.ts:196](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L196)
48+
[src/types.ts:196](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L196)
4949

5050
___
5151

@@ -59,7 +59,7 @@ ___
5959

6060
#### Defined in
6161

62-
[src/types.ts:194](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L194)
62+
[src/types.ts:194](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L194)
6363

6464
___
6565

@@ -73,7 +73,7 @@ ___
7373

7474
#### Defined in
7575

76-
[src/types.ts:197](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L197)
76+
[src/types.ts:197](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L197)
7777

7878
___
7979

@@ -87,7 +87,7 @@ ___
8787

8888
#### Defined in
8989

90-
[src/types.ts:195](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L195)
90+
[src/types.ts:195](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L195)
9191

9292
___
9393

@@ -97,4 +97,4 @@ ___
9797

9898
#### Defined in
9999

100-
[src/types.ts:97](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L97)
100+
[src/types.ts:97](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L97)

docs/interfaces/CreateCompletionStreamResponseUsage.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44

55
**`Export`**
66

7-
**`Interface`**
8-
97
CreateCompletionResponseUsage
108

119
## Hierarchy
@@ -39,7 +37,7 @@ CreateCompletionResponseUsage
3937

4038
#### Defined in
4139

42-
[src/types.ts:438](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L438)
40+
[src/types.ts:438](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L438)
4341

4442
___
4543

@@ -49,7 +47,7 @@ ___
4947

5048
#### Defined in
5149

52-
[src/types.ts:102](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L102)
50+
[src/types.ts:102](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L102)
5351

5452
___
5553

@@ -67,7 +65,7 @@ CreateCompletionResponseUsage
6765

6866
#### Defined in
6967

70-
[src/types.ts:432](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L432)
68+
[src/types.ts:432](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L432)
7169

7270
___
7371

@@ -85,4 +83,4 @@ CreateCompletionResponseUsage
8583

8684
#### Defined in
8785

88-
[src/types.ts:444](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L444)
86+
[src/types.ts:444](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L444)

docs/interfaces/openai.ChatCompletionRequestMessage.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66

77
**`Export`**
88

9-
**`Interface`**
10-
119
ChatCompletionRequestMessage
1210

1311
## Table of contents
@@ -32,7 +30,7 @@ ChatCompletionRequestMessage
3230

3331
#### Defined in
3432

35-
[src/types.ts:227](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L227)
33+
[src/types.ts:227](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L227)
3634

3735
___
3836

@@ -48,7 +46,7 @@ ChatCompletionRequestMessage
4846

4947
#### Defined in
5048

51-
[src/types.ts:233](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L233)
49+
[src/types.ts:233](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L233)
5250

5351
___
5452

@@ -64,4 +62,4 @@ ChatCompletionRequestMessage
6462

6563
#### Defined in
6664

67-
[src/types.ts:221](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L221)
65+
[src/types.ts:221](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L221)

docs/interfaces/openai.ChatCompletionResponseMessage.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66

77
**`Export`**
88

9-
**`Interface`**
10-
119
ChatCompletionResponseMessage
1210

1311
## Table of contents
@@ -31,7 +29,7 @@ ChatCompletionResponseMessage
3129

3230
#### Defined in
3331

34-
[src/types.ts:259](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L259)
32+
[src/types.ts:259](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L259)
3533

3634
___
3735

@@ -47,4 +45,4 @@ ChatCompletionResponseMessage
4745

4846
#### Defined in
4947

50-
[src/types.ts:253](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L253)
48+
[src/types.ts:253](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L253)

docs/interfaces/openai.CreateChatCompletionDeltaResponse.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
#### Defined in
3030

31-
[src/types.ts:198](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L198)
31+
[src/types.ts:198](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L198)
3232

3333
___
3434

@@ -38,7 +38,7 @@ ___
3838

3939
#### Defined in
4040

41-
[src/types.ts:196](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L196)
41+
[src/types.ts:196](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L196)
4242

4343
___
4444

@@ -48,7 +48,7 @@ ___
4848

4949
#### Defined in
5050

51-
[src/types.ts:194](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L194)
51+
[src/types.ts:194](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L194)
5252

5353
___
5454

@@ -58,7 +58,7 @@ ___
5858

5959
#### Defined in
6060

61-
[src/types.ts:197](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L197)
61+
[src/types.ts:197](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L197)
6262

6363
___
6464

@@ -68,4 +68,4 @@ ___
6868

6969
#### Defined in
7070

71-
[src/types.ts:195](https://github.com/transitive-bullshit/chatgpt-api/blob/bf66500/src/types.ts#L195)
71+
[src/types.ts:195](https://github.com/transitive-bullshit/chatgpt-api/blob/fb06beb/src/types.ts#L195)

0 commit comments

Comments
 (0)