Class PinningAggregation

Multitude of pinning services united.

Hierarchy

PinningAggregation

Implements

PinningBackend

Index

Constructors

Properties

Methods

close info ls open pin unpin build

Constructors

constructor

new PinningAggregation(backends: PinningBackend[]): PinningAggregation
Parameters
- backends: PinningBackend[]
Returns PinningAggregation
- Defined in packages/pinning-aggregation/src/index.ts:51

Properties

`Readonly` backends

backends: PinningBackend[]

`Readonly` id

id: string

Methods

close

close(): Promise<void>
Close all the services. Async semantics: every call should succeed.

Returns Promise<void>
Implementation of PinningBackend.close
- Defined in packages/pinning-aggregation/src/index.ts:72

info

info(): Promise<PinningInfo>
Returns Promise<PinningInfo>
Implementation of PinningBackend.info
- Defined in packages/pinning-aggregation/src/index.ts:108

ls

ls(): Promise<CidList>
List pinned CIDs.

Returns Promise<CidList>
Implementation of PinningBackend.ls
- Defined in packages/pinning-aggregation/src/index.ts:98

open

open(): void
Open all the services. Async semantics: every call should succeed.

Returns void
Implementation of PinningBackend.open
- Defined in packages/pinning-aggregation/src/index.ts:64

pin

pin(cid: CID<unknown, number, number, Version>): Promise<void>
Pin stream. Async semantics: every call should succeed.
Parameters
- cid: CID<unknown, number, number, Version>
Returns Promise<void>
Implementation of PinningBackend.pin
- Defined in packages/pinning-aggregation/src/index.ts:80

unpin

unpin(cid: CID<unknown, number, number, Version>): Promise<void>
Unpin CID. Async semantics: individual call failures do not propagate upstream; anything goes.
Parameters
- cid: CID<unknown, number, number, Version>
Returns Promise<void>
Implementation of PinningBackend.unpin
- Defined in packages/pinning-aggregation/src/index.ts:89

`Static` build

build(ipfs: IpfsApi, connectionStrings: string[], pinners?: PinningBackendStatic[]): PinningAggregation
Parameters
- ipfs: IpfsApi
- connectionStrings: string[]
- pinners: PinningBackendStatic[] = []
Returns PinningAggregation
- Defined in packages/pinning-aggregation/src/index.ts:31