Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StorageConfig

Hierarchy

  • StorageConfig

Index

Properties

Properties

apply

apply: (cid: string, opts?: ApplyOptions) => Promise<AsObject>

Apply a storage config or the default to the specified cid.

param

The cid to store.

param

Options controlling the behavior storage config execution.

returns

An object containing the job id of the job executing the storage configuration.

Type declaration

default

default: () => Promise<AsObject>

Get the default storage config associated with the current user.

returns

The default storage config.

Type declaration

remove

remove: (cid: string) => Promise<AsObject>

Remove a cid from the user storage.

param

The cid to remove.

Type declaration

    • Parameters

      • cid: string

      Returns Promise<AsObject>

setDefault

setDefault: (config: SConfig.AsObject) => Promise<AsObject>

Set the default storage config for this user.

param

The new default storage config.

Type declaration

    • (config: SConfig.AsObject): Promise<AsObject>

    • Parameters

      • config: SConfig.AsObject

      Returns Promise<AsObject>

Generated using TypeDoc