Class DataTape

DataTape is a file or stream that consists of a sequence of Data packets. This type implements DataStore interfaces on top of such a file or stream.

Implements

Index

Constructors

Methods

[asyncDispose] find get insert listData listNames

Constructors

constructor

new DataTape(
stream: string | ReadableStream | WritableStream | OpenStream,
): DataTape
Constructor.
Parameters
- stream: string | ReadableStream | WritableStream | OpenStream
  Stream or how to open the stream.
Returns DataTape
Remarks
stream could be:
- a readable/writable stream;
- a function to (re)open the stream;
- a filename.
DataTape.Reader methods are available only if the stream is readable. DataTape.Writer methods are available only if the stream is writable.

If stream is a stream instance, it allows either one read or multiple writes. If stream is an opener function or filename, it allows multiple reads and writes. Function calls must be sequenced because this type is non-thread-safe.
- Defined in data-tape.ts:36

Methods

[asyncDispose]

"[asyncDispose]"(): Promise<void>
Returns Promise<void>
Implementation of DataTape.Reader.[asyncDispose]
- Defined in data-tape.ts:146

find

find(interest: Interest): Promise<undefined | Data>
Find Data that satisfies Interest.
Parameters
- interest: Interest
Returns Promise<undefined | Data>
Implementation of DataTape.Reader.find
- Defined in data-tape.ts:137

get

get(name: Name): Promise<undefined | Data>
Retrieve Data by exact name.
Parameters
- name: Name
Returns Promise<undefined | Data>
Implementation of DataTape.Reader.get
- Defined in data-tape.ts:133

insert

insert(
    ...args:
        | (Data | AnyIterable<Data>)[]
        | [{}, ...(Data | AnyIterable<Data>)[]],
): Promise<void>
Insert one or more Data packets.
Parameters
- ...args: (Data | AnyIterable<Data>)[] | [{}, ...(Data | AnyIterable<Data>)[]]
Returns Promise<void>
Remarks
Arguments include:
- an optional Options object
- zero or more Data, Iterable, or AsyncIterable
Implementation of DataTape.Writer.insert
- Defined in data-tape.ts:141

listData

listData(prefix?: Name): AsyncIterable<Data, any, any>
List Data packets, optionally filtered by name prefix.
Parameters
- Optionalprefix: Name
Returns AsyncIterable<Data, any, any>
Implementation of DataTape.Reader.listData
- Defined in data-tape.ts:112

listNames

listNames(prefix?: Name): AsyncIterable<Name, any, any>
List Data names, optionally filtered by name prefix.
Parameters
- Optionalprefix: Name
Returns AsyncIterable<Name, any, any>
Implementation of DataTape.Reader.listNames
- Defined in data-tape.ts:108