-
Notifications
You must be signed in to change notification settings - Fork 111
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix doc generation for audius/sdk (#5584)
- Loading branch information
Showing
99 changed files
with
11,004 additions
and
656 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
id: "AppAuth" | ||
title: "AppAuth" | ||
sidebar_position: 0 | ||
custom_edit_url: null | ||
--- | ||
|
||
AuthService for Developer Apps wishing to write on a user's behalf | ||
|
||
## Implements | ||
|
||
- [`AuthService`](../modules.md#authservice) | ||
|
||
## Methods | ||
|
||
### signTransaction | ||
|
||
**signTransaction**(`data`): `Promise`<`string`\> | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `data` | `EIP712TypedData` | | ||
|
||
#### Returns | ||
|
||
`Promise`<`string`\> | ||
|
||
#### Implementation of | ||
|
||
AuthService.signTransaction |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
id: "Auth" | ||
title: "Auth" | ||
sidebar_position: 0 | ||
custom_edit_url: null | ||
--- | ||
|
||
## Implements | ||
|
||
- [`AuthService`](../modules.md#authservice) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,153 @@ | ||
--- | ||
id: "BaseAPI" | ||
title: "BaseAPI" | ||
sidebar_position: 0 | ||
custom_edit_url: null | ||
--- | ||
|
||
This is the base class for all generated API classes. | ||
|
||
## Methods | ||
|
||
### clone | ||
|
||
`Private` **clone**<`T`\>(`this`): `T` | ||
|
||
Create a shallow clone of `this` by constructing a new instance | ||
and then shallow cloning data members. | ||
|
||
#### Type parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `T` | extends [`BaseAPI`](BaseAPI.md)<`T`\> | | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `this` | `T` | | ||
|
||
#### Returns | ||
|
||
`T` | ||
|
||
___ | ||
|
||
### createFetchParams | ||
|
||
`Private` **createFetchParams**(`context`, `initOverrides?`): `Promise`<{ `init`: `RequestInit` ; `url`: `string` }\> | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `context` | [`RequestOpts`](../interfaces/RequestOpts.md) | | ||
| `initOverrides?` | `RequestInit` \| [`InitOverrideFunction`](../modules.md#initoverridefunction) | | ||
|
||
#### Returns | ||
|
||
`Promise`<{ `init`: `RequestInit` ; `url`: `string` }\> | ||
|
||
___ | ||
|
||
### fetchApi | ||
|
||
`Private` **fetchApi**(`url`, `init`): `Promise`<`Response`\> | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `url` | `string` | | ||
| `init` | `RequestInit` | | ||
|
||
#### Returns | ||
|
||
`Promise`<`Response`\> | ||
|
||
___ | ||
|
||
### request | ||
|
||
`Protected` **request**(`context`, `initOverrides?`): `Promise`<`Response`\> | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `context` | [`RequestOpts`](../interfaces/RequestOpts.md) | | ||
| `initOverrides?` | `RequestInit` \| [`InitOverrideFunction`](../modules.md#initoverridefunction) | | ||
|
||
#### Returns | ||
|
||
`Promise`<`Response`\> | ||
|
||
___ | ||
|
||
### withMiddleware | ||
|
||
**withMiddleware**<`T`\>(`this`, ...`middlewares`): `T` | ||
|
||
#### Type parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `T` | extends [`BaseAPI`](BaseAPI.md)<`T`\> | | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `this` | `T` | | ||
| `...middlewares` | [`Middleware`](../interfaces/Middleware.md)[] | | ||
|
||
#### Returns | ||
|
||
`T` | ||
|
||
___ | ||
|
||
### withPostMiddleware | ||
|
||
**withPostMiddleware**<`T`\>(`this`, ...`postMiddlewares`): `T` | ||
|
||
#### Type parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `T` | extends [`BaseAPI`](BaseAPI.md)<`T`\> | | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `this` | `T` | | ||
| `...postMiddlewares` | (`undefined` \| (`context`: [`ResponseContext`](../interfaces/ResponseContext.md)) => `Promise`<`void` \| `Response`\>)[] | | ||
|
||
#### Returns | ||
|
||
`T` | ||
|
||
___ | ||
|
||
### withPreMiddleware | ||
|
||
**withPreMiddleware**<`T`\>(`this`, ...`preMiddlewares`): `T` | ||
|
||
#### Type parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `T` | extends [`BaseAPI`](BaseAPI.md)<`T`\> | | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `this` | `T` | | ||
| `...preMiddlewares` | (`undefined` \| (`context`: [`RequestContext`](../interfaces/RequestContext.md)) => `Promise`<`void` \| [`FetchParams`](../interfaces/FetchParams.md)\>)[] | | ||
|
||
#### Returns | ||
|
||
`T` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
id: "BlobApiResponse" | ||
title: "BlobResponse" | ||
sidebar_position: 0 | ||
custom_edit_url: null | ||
--- | ||
|
||
## Methods | ||
|
||
### value | ||
|
||
**value**(): `Promise`<`Blob`\> | ||
|
||
#### Returns | ||
|
||
`Promise`<`Blob`\> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.