Skip to content

Commit

Permalink
doc(sdks/ts): Generate docs for sdks/ts (CI)
Browse files Browse the repository at this point in the history
  • Loading branch information
whiterabbit1983 authored and github-actions[bot] committed Jul 1, 2024
1 parent 471e599 commit 0ebb285
Show file tree
Hide file tree
Showing 20 changed files with 234 additions and 226 deletions.
17 changes: 11 additions & 6 deletions docs/js-sdk-docs/classes/api.ApiError.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Error.constructor

#### Defined in

[src/api/core/ApiError.ts:15](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/ApiError.ts#L15)
[src/api/core/ApiError.ts:15](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/ApiError.ts#L15)

## Properties

Expand All @@ -67,7 +67,8 @@ Error.constructor

#### Defined in

[src/api/core/ApiError.ts:12](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/ApiError.ts#L12)
[src/api/core/ApiError.ts:12](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/ApiError.ts#L12)

___

### message
Expand Down Expand Up @@ -104,7 +105,8 @@ ___

#### Defined in

[src/api/core/ApiError.ts:13](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/ApiError.ts#L13)
[src/api/core/ApiError.ts:13](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/ApiError.ts#L13)

___

### stack
Expand All @@ -127,7 +129,8 @@ ___

#### Defined in

[src/api/core/ApiError.ts:10](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/ApiError.ts#L10)
[src/api/core/ApiError.ts:10](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/ApiError.ts#L10)

___

### statusText
Expand All @@ -136,7 +139,8 @@ ___

#### Defined in

[src/api/core/ApiError.ts:11](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/ApiError.ts#L11)
[src/api/core/ApiError.ts:11](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/ApiError.ts#L11)

___

### url
Expand All @@ -145,7 +149,8 @@ ___

#### Defined in

[src/api/core/ApiError.ts:9](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/ApiError.ts#L9)
[src/api/core/ApiError.ts:9](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/ApiError.ts#L9)

___

### prepareStackTrace
Expand Down
6 changes: 3 additions & 3 deletions docs/js-sdk-docs/classes/api.BaseHttpRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@

#### Defined in

[src/api/core/BaseHttpRequest.ts:10](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/BaseHttpRequest.ts#L10)
[src/api/core/BaseHttpRequest.ts:10](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/BaseHttpRequest.ts#L10)

## Properties

Expand All @@ -46,7 +46,7 @@

#### Defined in

[src/api/core/BaseHttpRequest.ts:10](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/BaseHttpRequest.ts#L10)
[src/api/core/BaseHttpRequest.ts:10](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/BaseHttpRequest.ts#L10)

## Methods

Expand All @@ -72,4 +72,4 @@

#### Defined in

[src/api/core/BaseHttpRequest.ts:12](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/BaseHttpRequest.ts#L12)
[src/api/core/BaseHttpRequest.ts:12](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/BaseHttpRequest.ts#L12)
4 changes: 2 additions & 2 deletions docs/js-sdk-docs/classes/api.CancelError.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Error.constructor

#### Defined in

[src/api/core/CancelablePromise.ts:6](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/CancelablePromise.ts#L6)
[src/api/core/CancelablePromise.ts:6](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/CancelablePromise.ts#L6)

## Properties

Expand Down Expand Up @@ -159,7 +159,7 @@ node_modules/@types/node/globals.d.ts:30

#### Defined in

[src/api/core/CancelablePromise.ts:11](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/CancelablePromise.ts#L11)
[src/api/core/CancelablePromise.ts:11](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/CancelablePromise.ts#L11)

## Methods

Expand Down
31 changes: 17 additions & 14 deletions docs/js-sdk-docs/classes/api.CancelablePromise.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@

#### Defined in

[src/api/core/CancelablePromise.ts:33](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/CancelablePromise.ts#L33)
[src/api/core/CancelablePromise.ts:33](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/CancelablePromise.ts#L33)

## Properties

Expand All @@ -76,7 +76,7 @@

#### Defined in

[src/api/core/CancelablePromise.ts:28](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/CancelablePromise.ts#L28)
[src/api/core/CancelablePromise.ts:28](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/CancelablePromise.ts#L28)

___

Expand All @@ -86,7 +86,7 @@ ___

#### Defined in

[src/api/core/CancelablePromise.ts:27](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/CancelablePromise.ts#L27)
[src/api/core/CancelablePromise.ts:27](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/CancelablePromise.ts#L27)

___

Expand All @@ -96,7 +96,7 @@ ___

#### Defined in

[src/api/core/CancelablePromise.ts:26](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/CancelablePromise.ts#L26)
[src/api/core/CancelablePromise.ts:26](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/CancelablePromise.ts#L26)

___

Expand All @@ -106,7 +106,7 @@ ___

#### Defined in

[src/api/core/CancelablePromise.ts:25](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/CancelablePromise.ts#L25)
[src/api/core/CancelablePromise.ts:25](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/CancelablePromise.ts#L25)

___

Expand All @@ -116,7 +116,7 @@ ___

#### Defined in

[src/api/core/CancelablePromise.ts:29](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/CancelablePromise.ts#L29)
[src/api/core/CancelablePromise.ts:29](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/CancelablePromise.ts#L29)

___

Expand All @@ -140,7 +140,7 @@ ___

#### Defined in

[src/api/core/CancelablePromise.ts:31](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/CancelablePromise.ts#L31)
[src/api/core/CancelablePromise.ts:31](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/CancelablePromise.ts#L31)

___

Expand All @@ -164,7 +164,7 @@ ___

#### Defined in

[src/api/core/CancelablePromise.ts:30](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/CancelablePromise.ts#L30)
[src/api/core/CancelablePromise.ts:30](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/CancelablePromise.ts#L30)

## Accessors

Expand All @@ -182,7 +182,8 @@ Promise.[toStringTag]

#### Defined in

[src/api/core/CancelablePromise.ts:87](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/CancelablePromise.ts#L87)
[src/api/core/CancelablePromise.ts:87](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/CancelablePromise.ts#L87)

___

### isCancelled
Expand All @@ -195,7 +196,7 @@ ___

#### Defined in

[src/api/core/CancelablePromise.ts:127](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/CancelablePromise.ts#L127)
[src/api/core/CancelablePromise.ts:127](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/CancelablePromise.ts#L127)

## Methods

Expand All @@ -209,7 +210,7 @@ ___

#### Defined in

[src/api/core/CancelablePromise.ts:108](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/CancelablePromise.ts#L108)
[src/api/core/CancelablePromise.ts:108](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/CancelablePromise.ts#L108)

___

Expand Down Expand Up @@ -239,7 +240,8 @@ Promise.catch

#### Defined in

[src/api/core/CancelablePromise.ts:98](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/CancelablePromise.ts#L98)
[src/api/core/CancelablePromise.ts:98](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/CancelablePromise.ts#L98)

___

### finally
Expand All @@ -262,7 +264,8 @@ Promise.finally

#### Defined in

[src/api/core/CancelablePromise.ts:104](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/CancelablePromise.ts#L104)
[src/api/core/CancelablePromise.ts:104](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/CancelablePromise.ts#L104)

___

### then
Expand Down Expand Up @@ -293,4 +296,4 @@ Promise.then

#### Defined in

[src/api/core/CancelablePromise.ts:91](https://github.com/julep-ai/julep/blob/14c08d97001b8adf9223981b8dcab2e2cd1c3962/sdks/ts/src/api/core/CancelablePromise.ts#L91)
[src/api/core/CancelablePromise.ts:91](https://github.com/julep-ai/julep/blob/471e599107c50ed1e6538fbbf66ae4e3cdb5c479/sdks/ts/src/api/core/CancelablePromise.ts#L91)
Loading

0 comments on commit 0ebb285

Please sign in to comment.