This page is auto-generated from TypeDoc based on the @lumeweb/web source code. Do not edit directly.
Client for managing IPNS keys and publishing content to IPNS names.
Constructor
new IpnsClient(config: PinnerConfig, auth: AuthManager)| Parameter | Type | Description |
|---|---|---|
config | PinnerConfig | SDK configuration |
auth | AuthManager | AuthManager for authentication |
Methods
| Method | Returns | Description |
|---|---|---|
request(path, options) | Promise<T> | |
mapError(error) | Promise<Error> | |
listKeys(options) | Promise<IPNSKeyListResponseResponse> | List all IPNS keys. |
getKey(id, options) | Promise<IPNSKeyResponse> | Get a specific IPNS key by ID. |
createKey(request, options) | Promise<IPNSKeyResponse> | Create a new IPNS key. |
deleteKey(id, options) | Promise<void> | Delete an IPNS key by ID. |
publish(request, options) | Promise<IPNSPublishResponse> | Publish content to an IPNS name. |
republish(id, options) | Promise<IPNSRepublishResponse> | Republish (refresh) an existing IPNS record. |
resolve(name, options) | Promise<IPNSResolveResponse> | Resolve an IPNS name to its content. |
request(path, options?)
request(path: string, options?: RequestInit & object): Promise<T>Parameters:
| Name | Type | Description |
|---|---|---|
path | string | |
options | RequestInit & object | optional |
Returns: Promise<T>
mapError(error)
mapError(error: unknown): Promise<Error>Parameters:
| Name | Type | Description |
|---|---|---|
error | unknown |
Returns: Promise<Error>
listKeys(options?)
listKeys(options?: IpnsClientOptions): Promise<IPNSKeyListResponseResponse>List all IPNS keys.
Parameters:
| Name | Type | Description |
|---|---|---|
options | IpnsClientOptions | Request options optional |
Returns: Promise<IPNSKeyListResponseResponse>
getKey(id, options?)
getKey(id: number, options?: IpnsClientOptions): Promise<IPNSKeyResponse>Get a specific IPNS key by ID.
Parameters:
| Name | Type | Description |
|---|---|---|
id | number | Key ID |
options | IpnsClientOptions | Request options optional |
Returns: Promise<IPNSKeyResponse>
createKey(request, options?)
createKey(request: IPNSKeyRequest, options?: IpnsClientOptions): Promise<IPNSKeyResponse>Create a new IPNS key.
Parameters:
| Name | Type | Description |
|---|---|---|
request | IPNSKeyRequest | Key creation parameters |
options | IpnsClientOptions | Request options optional |
Returns: Promise<IPNSKeyResponse>
deleteKey(id, options?)
deleteKey(id: number, options?: IpnsClientOptions): Promise<void>Delete an IPNS key by ID.
Parameters:
| Name | Type | Description |
|---|---|---|
id | number | Key ID to delete |
options | IpnsClientOptions | Request options optional |
Returns: Promise<void>
publish(request, options?)
publish(request: IPNSPublishRequest, options?: IpnsClientOptions): Promise<IPNSPublishResponse>Publish content to an IPNS name.
Parameters:
| Name | Type | Description |
|---|---|---|
request | IPNSPublishRequest | Publishing parameters |
options | IpnsClientOptions | Request options optional |
Returns: Promise<IPNSPublishResponse>
republish(id, options?)
republish(id: number, options?: IpnsClientOptions): Promise<IPNSRepublishResponse>Republish (refresh) an existing IPNS record.
Parameters:
| Name | Type | Description |
|---|---|---|
id | number | Key ID to republish |
options | IpnsClientOptions | Request options optional |
Returns: Promise<IPNSRepublishResponse>
resolve(name, options?)
resolve(name: string, options?: IpnsClientOptions): Promise<IPNSResolveResponse>Resolve an IPNS name to its content.
Parameters:
| Name | Type | Description |
|---|---|---|
name | string | IPNS name to resolve |
options | IpnsClientOptions | Request options optional |
Returns: Promise<IPNSResolveResponse>