Class: PinningApi
PinningApi - object-oriented interface
Export
Hierarchy
↳
PinningApi
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new PinningApi(configuration?, basePath?, fetch?)
Parameters
| Name | Type | Default value |
|---|---|---|
configuration? | Configuration | undefined |
basePath | string | BASE_PATH |
fetch | FetchAPI | portableFetch |
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
Properties
basePath
• Protected basePath: string = BASE_PATH
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
configuration
• Protected configuration: Configuration
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:58
fetch
• Protected fetch: FetchAPI = portableFetch
Inherited from
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:60
Methods
pinningPinsGet
▸ pinningPinsGet(options?): Promise<Response>
This endpoint lists all pin status objects
Summary
List all pin status objects
Throws
Memberof
PinningApi
Parameters
| Name | Type | Description |
|---|---|---|
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:6559
pinningPinsPinidDelete
▸ pinningPinsPinidDelete(pinid, options?): Promise<Response>
This endpoint deletes a pinned object.
Summary
Delete a pinned object
Throws
Memberof
PinningApi
Parameters
| Name | Type | Description |
|---|---|---|
pinid | string | Pin ID |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:6571
pinningPinsPinidGet
▸ pinningPinsPinidGet(pinid, options?): Promise<Response>
This endpoint returns a pin status object.
Summary
Get a pin status object
Throws
Memberof
PinningApi
Parameters
| Name | Type | Description |
|---|---|---|
pinid | string | cid |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:6583
pinningPinsPinidPost
▸ pinningPinsPinidPost(pinid, options?): Promise<Response>
This endpoint replaces a pinned object.
Summary
Replace a pinned object
Throws
Memberof
PinningApi
Parameters
| Name | Type | Description |
|---|---|---|
pinid | string | Pin ID |
options? | any | Override http request option. |
Returns
Promise<Response>
Defined in
dev/estuary/estuary-clients/typescript-fetch/api.ts:6595
pinningPinsPost
▸ pinningPinsPost(cid, name, options?): Promise<Response>
This endpoint adds a pin to the IPFS daemon.
Summary
Add and pin object
Throws
Memberof
PinningApi
Parameters
| Name | Type | Description |
|---|---|---|
cid | string | cid |
name | string | name |
options? | any | Override http request option. |
Returns
Promise<Response>