Class S3Blockstore

A blockstore backed by AWS S3

Hierarchy (View Summary)

BaseBlockstore
- S3Blockstore

Index

Constructors

constructor

new S3Blockstore(s3: S3, bucket: string, init?: S3BlockstoreInit): S3Blockstore
Parameters
- s3: S3
- bucket: string
- Optionalinit: S3BlockstoreInit
Returns S3Blockstore
Overrides BaseBlockstore.constructor
- Defined in blockstore-s3/src/index.ts:79

Properties

createIfMissing

createIfMissing: boolean

Methods

delete

delete(key: CID, options?: AbortOptions): Promise<void>
Delete the record under the given key
Parameters
- key: CID
- Optionaloptions: AbortOptions
Returns Promise<void>
Overrides BaseBlockstore.delete
- Defined in blockstore-s3/src/index.ts:202

deleteMany

deleteMany(
    source:
        | Iterable<CID<unknown, number, number, Version>, any, any>
        | AsyncIterable<CID<unknown, number, number, Version>, any, any>,
    options?: AbortOptions,
):
    | Generator<CID<unknown, number, number, Version>, any, any>
    | AsyncGenerator<CID<unknown, number, number, Version>, any, any>
Remove values for the passed keys
Parameters
- source:
  | Iterable<CID<unknown, number, number, Version>, any, any>
  | AsyncIterable<CID<unknown, number, number, Version>, any, any>
- Optionaloptions: AbortOptions
Returns
| Generator<CID<unknown, number, number, Version>, any, any>
| AsyncGenerator<CID<unknown, number, number, Version>, any, any>
Example
```
const source = [new Key('awesome')]

for await (const key of store.deleteMany(source)) {
  console.log(`deleted content with key ${key}`)
}
```
Inherited from BaseBlockstore.deleteMany
- Defined in blockstore-core/dist/src/base.d.ts:11

get

get(
    key: CID,
    options?: AbortOptions,
):
    | Generator<Uint8Array<ArrayBufferLike>, any, any>
    | AsyncGenerator<Uint8Array<ArrayBufferLike>, any, any>
Read from s3
Parameters
- key: CID
- Optionaloptions: AbortOptions
Returns
| Generator<Uint8Array<ArrayBufferLike>, any, any>
| AsyncGenerator<Uint8Array<ArrayBufferLike>, any, any>
Overrides BaseBlockstore.get
- Defined in blockstore-s3/src/index.ts:121

getAll

getAll(
options?: AbortOptions,
): Generator<Pair, any, any> | AsyncGenerator<Pair, any, any>
Extending classes should override query or implement this method
Parameters
- Optionaloptions: AbortOptions
Returns Generator<Pair, any, any> | AsyncGenerator<Pair, any, any>
Overrides BaseBlockstore.getAll
- Defined in blockstore-s3/src/index.ts:218

getMany

getMany(
    source:
        | Iterable<CID<unknown, number, number, Version>, any, any>
        | AsyncIterable<CID<unknown, number, number, Version>, any, any>,
    options?: AbortOptions,
): Generator<Pair, any, any> | AsyncGenerator<Pair, any, any>
Retrieve values for the passed keys
Parameters
- source:
  | Iterable<CID<unknown, number, number, Version>, any, any>
  | AsyncIterable<CID<unknown, number, number, Version>, any, any>
- Optionaloptions: AbortOptions
Returns Generator<Pair, any, any> | AsyncGenerator<Pair, any, any>
Example
```
for await (const { key, value } of store.getMany([new Key('awesome')])) {
  console.log(`got "${key}" = "${new TextDecoder('utf8').decode(value)}"`')
  // => got "/awesome" = "datastore"
}
```
Inherited from BaseBlockstore.getMany
- Defined in blockstore-core/dist/src/base.d.ts:9

has

has(key: CID, options?: AbortOptions): Promise<boolean>
Check for the existence of the given key
Parameters
- key: CID
- Optionaloptions: AbortOptions
Returns Promise<boolean>
Overrides BaseBlockstore.has
- Defined in blockstore-s3/src/index.ts:171

open

open(options?: AbortOptions): Promise<void>
This will check the s3 bucket to ensure access and existence
Parameters
- Optionaloptions: AbortOptions
Returns Promise<void>
- Defined in blockstore-s3/src/index.ts:275

put

put(
    key: CID,
    val: Uint8Array,
    options?: AbortOptions,
): Promise<CID<unknown, number, number, Version>>
Store the given value under the key.
Parameters
- key: CID
- val: Uint8Array
- Optionaloptions: AbortOptions
Returns Promise<CID<unknown, number, number, Version>>
Overrides BaseBlockstore.put
- Defined in blockstore-s3/src/index.ts:99

putMany

putMany(
    source:
        | Iterable<InputPair, any, any>
        | AsyncIterable<InputPair, any, any>,
    options?: AbortOptions,
):
    | Generator<CID<unknown, number, number, Version>, any, any>
    | AsyncGenerator<CID<unknown, number, number, Version>, any, any>
Store the given key/value pairs
Parameters
- source: Iterable<InputPair, any, any> | AsyncIterable<InputPair, any, any>
- Optionaloptions: AbortOptions
Returns
| Generator<CID<unknown, number, number, Version>, any, any>
| AsyncGenerator<CID<unknown, number, number, Version>, any, any>
Example
```
const source = [{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }]

for await (const { key, value } of store.putMany(source)) {
  console.info(`put content for key ${key}`)
}
```
Inherited from BaseBlockstore.putMany
- Defined in blockstore-core/dist/src/base.d.ts:7

Class S3Blockstore

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns S3Blockstore

Properties

createIfMissing

Methods

delete

Parameters

Returns Promise<void>

deleteMany

Parameters

Returns | Generator<CID<unknown, number, number, Version>, any, any> | AsyncGenerator<CID<unknown, number, number, Version>, any, any>

Example

get

Parameters

Returns | Generator<Uint8Array<ArrayBufferLike>, any, any> | AsyncGenerator<Uint8Array<ArrayBufferLike>, any, any>

getAll

Parameters

Returns Generator<Pair, any, any> | AsyncGenerator<Pair, any, any>

getMany

Parameters

Returns Generator<Pair, any, any> | AsyncGenerator<Pair, any, any>

Example

has

Parameters

Returns Promise<boolean>

open

Parameters

Returns Promise<void>

put

Parameters

Returns Promise<CID<unknown, number, number, Version>>

putMany

Parameters

Returns | Generator<CID<unknown, number, number, Version>, any, any> | AsyncGenerator<CID<unknown, number, number, Version>, any, any>

Example

Settings

On This Page

Returns
| Generator<CID<unknown, number, number, Version>, any, any>
| AsyncGenerator<CID<unknown, number, number, Version>, any, any>

Returns
| Generator<Uint8Array<ArrayBufferLike>, any, any>
| AsyncGenerator<Uint8Array<ArrayBufferLike>, any, any>

Returns
| Generator<CID<unknown, number, number, Version>, any, any>
| AsyncGenerator<CID<unknown, number, number, Version>, any, any>