Class StoreClient

Client for interacting with the store/* capabilities.

Hierarchy

Base
- StoreClient

Index

Constructors

constructor

new StoreClient(agentData: AgentData, options??: {
serviceConf: undefined | ServiceConf;
}): StoreClient
Parameters
- agentData: AgentData
- Optional options: {
  serviceConf: undefined | ServiceConf;
  } = {}
  - serviceConf: undefined | ServiceConf
Returns StoreClient
Inherited from Base.constructor
- Defined in src/base.js:22

Properties

`Protected` _agent

_agent: Agent

`Protected` _serviceConf

_serviceConf: ServiceConf

Methods

`Protected` _invocationConfig

_invocationConfig(abilities: Ability[]): Promise<{
    audience: Principal<`did:${string}:${string}`>;
    issuer: Signer<`did:${string}:${string}`, SigAlg>;
    proofs: Delegation<Capabilities>[];
    with: `did:${string}:${string}`;
}>
Protected
Parameters
- abilities: Ability[]
Returns Promise<{
    audience: Principal<`did:${string}:${string}`>;
    issuer: Signer<`did:${string}:${string}`, SigAlg>;
    proofs: Delegation<Capabilities>[];
    with: `did:${string}:${string}`;
}>
Inherited from Base._invocationConfig
- Defined in src/base.js:36

add

add(car: Blob, options??: RequestOptions): Promise<CARLink>
Store a DAG encoded as a CAR file.
Parameters
- car: Blob
  
  CAR file data.
- Optional options: RequestOptions = {}
Returns Promise<CARLink>
- Defined in src/capability/store.js:15

list

list(options??: ListRequestOptions): Promise<ListResponse<StoreListResult>>
List CAR files stored to the resource.
Parameters
- Optional options: ListRequestOptions = {}
Returns Promise<ListResponse<StoreListResult>>
- Defined in src/capability/store.js:26

remove

remove(link: CARLink, options??: RequestOptions): Promise<void>
Remove a stored CAR file by CAR CID.
Parameters
- link: CARLink
  
  CID of CAR file to remove.
- Optional options: RequestOptions = {}
Returns Promise<void>
- Defined in src/capability/store.js:38

Class StoreClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

agentData: AgentData

`Optional` options: {
serviceConf: undefined | ServiceConf;
} = {}

serviceConf: undefined | ServiceConf

Returns StoreClient

Properties

`Protected` _agent

`Protected` _serviceConf

Methods

`Protected` _invocationConfig

Parameters

abilities: Ability[]

Returns Promise<{
    audience: Principal<`did:${string}:${string}`>;
    issuer: Signer<`did:${string}:${string}`, SigAlg>;
    proofs: Delegation<Capabilities>[];
    with: `did:${string}:${string}`;
}>

add

Parameters

car: Blob

`Optional` options: RequestOptions = {}

Returns Promise<CARLink>

list

Parameters

`Optional` options: ListRequestOptions = {}

Returns Promise<ListResponse<StoreListResult>>

remove

Parameters

link: CARLink

`Optional` options: RequestOptions = {}

Returns Promise<void>

Settings

Member Visibility

Theme

Class StoreClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

agentData: AgentData

Optional options: { serviceConf: undefined | ServiceConf; } = {}

serviceConf: undefined | ServiceConf

Returns StoreClient

Properties

Protected _agent

Protected _serviceConf

Methods

Protected _invocationConfig

Parameters

abilities: Ability[]

Returns Promise<{ audience: Principal<`did:${string}:${string}`>; issuer: Signer<`did:${string}:${string}`, SigAlg>; proofs: Delegation<Capabilities>[]; with: `did:${string}:${string}`; }>

add

Parameters

car: Blob

Optional options: RequestOptions = {}

Returns Promise<CARLink>

list

Parameters

Optional options: ListRequestOptions = {}

Returns Promise<ListResponse<StoreListResult>>

remove

Parameters

link: CARLink

Optional options: RequestOptions = {}

Returns Promise<void>

Settings

Member Visibility

Theme

`Optional` options: {
serviceConf: undefined | ServiceConf;
} = {}

`Protected` _agent

`Protected` _serviceConf

`Protected` _invocationConfig

Returns Promise<{
audience: Principal<`did:${string}:${string}`>;
issuer: Signer<`did:${string}:${string}`, SigAlg>;
proofs: Delegation<Capabilities>[];
with: `did:${string}:${string}`;
}>

`Optional` options: RequestOptions = {}

`Optional` options: ListRequestOptions = {}

`Optional` options: RequestOptions = {}