Skip to main content

Namespace: Store

@web3-storage/capabilities.Space.Store

Store Capabilities

These can be imported directly with:

import * as Account from '@web3-storage/capabilities/store'

Variables

add

Const add: TheCapabilityParser<DerivedMatch<{}, CapabilityMatch<"*", URI<"did:">, {}> | DerivedMatch<{}, CapabilityMatch<"*", URI<"did:">, {}>>>>

store/add capability allows agent to store a CAR file into a (memory) space identified by did:key in the with field. Agent must precompute CAR locally and provide it's CID and size using nb.link and nb.size fields, allowing a service to provision a write location for the agent to PUT or POST desired CAR into.

Defined in

packages/capabilities/src/store.js:51


all

Const all: CapabilityParser<DerivedMatch<{}, CapabilityMatch<"*", URI<"did:">, {}> | DerivedMatch<{}, CapabilityMatch<"*", URI<"did:">, {}>>> | DerivedMatch<{}, CapabilityMatch<"*", URI<"did:">, {}> | DerivedMatch<{}, CapabilityMatch<"*", URI<"did:">, {}>>> | DerivedMatch<{}, CapabilityMatch<"*", URI<"did:">, {}> | DerivedMatch<{}, CapabilityMatch<"*", URI<"did:">, {}>>>>

Defined in

packages/capabilities/src/store.js:170


list

Const list: TheCapabilityParser<DerivedMatch<{}, CapabilityMatch<"*", URI<"did:">, {}> | DerivedMatch<{}, CapabilityMatch<"*", URI<"did:">, {}>>>>

Capability can be invoked to request a list of stored CAR files in the (memory) space identified by with field.

Defined in

packages/capabilities/src/store.js:135


remove

Const remove: TheCapabilityParser<DerivedMatch<{}, CapabilityMatch<"*", URI<"did:">, {}> | DerivedMatch<{}, CapabilityMatch<"*", URI<"did:">, {}>>>>

Capability can be used to remove the stored CAR file from the (memory) space identified by with field.

Defined in

packages/capabilities/src/store.js:108


store

Const store: TheCapabilityParser<DerivedMatch<{}, CapabilityMatch<"*", URI<"did:">, {}>>>

Capability can only be delegated (but not invoked) allowing audience to derived any store/ prefixed capability for the (memory) space identified by did:key in the with field.

Defined in

packages/capabilities/src/store.js:20