Class: StoreClient

capability/store.StoreClient

Client for interacting with the store/* capabilities.

Hierarchy

• Base

  ↳ StoreClient

Constructors

constructor

• new StoreClient(agentData, options?)

Parameters

Name	Type
agentData	AgentData
options?	Object
options.serviceConf	undefined | ServiceConf

Inherited from

Base.constructor

Defined in

src/base.js:22

Properties

_agent

• Protected _agent: Agent

Inherited from

Base._agent

Defined in

src/base.js:9

---

_serviceConf

• Protected _serviceConf: ServiceConf

Inherited from

Base._serviceConf

Defined in

src/base.js:15

Methods

_invocationConfig

▸ Protected _invocationConfig(abilities): Promise<{ audience: Principal<`did:${string}:${string}`> ; issuer: Signer<`did:${string}:${string}`, SigAlg> ; proofs: Delegation<Capabilities>[] ; with: `did:${string}:${string}` = resource }>

Parameters

Name	Type
abilities	Ability[]

Returns

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

Inherited from

Base._invocationConfig

Defined in

src/base.js:36

---

add

▸ add(car, options?): Promise<CARLink>

Store a DAG encoded as a CAR file.

Parameters

Name	Type	Description
car	Blob	CAR file data.
options?	RequestOptions

Returns

Promise<CARLink>

Defined in

src/capability/store.js:15

---

list

▸ list(options?): Promise<ListResponse<StoreListResult>>

List CAR files stored to the resource.

Parameters

Name	Type
options?	ListRequestOptions

Returns

Promise<ListResponse<StoreListResult>>

Defined in

src/capability/store.js:26

---

remove

▸ remove(link, options?): Promise<void>

Remove a stored CAR file by CAR CID.

Parameters

Name	Type	Description
link	CARLink	CID of CAR file to remove.
options?	RequestOptions

Returns

Promise<void>

Defined in

src/capability/store.js:38