Common

const Common: object

Defined in: astrobase/src/common/common.ts:37

A base InstanceConfig that provides implementations for all supported codecs, procedure handlers, hash algorithms, content identifier schemes, and wrap types.

This design enables a “batteries included” experience with minimal configuration, while also allowing unparalleled tree-shakability and customisation. Most applications will use the common config as a base, with additional configs extending or even overriding features. In special cases the config can not be imported into the application at all, instead allowing a custom configuration to load only the functionality needed and leaving base functionality to be tree-shaken.

Type declaration

codecs

readonly codecs: object

codecs.application/astrobase-wrap

readonly application/astrobase-wrap: Codec<Unwrapped<unknown, unknown>> = WrapCodec

codecs.application/json

readonly application/json: Codec<unknown> = JsonCodec

codecs.application/octet-stream

readonly application/octet-stream: Codec<Uint8Array<ArrayBufferLike>> = BinaryCodec

hashAlgs

readonly hashAlgs: object

hashAlgs.0

readonly 0: HashFn = sha256

procedures

readonly procedures: object

procedures.content:delete()

readonly content:delete: (cid, instance) => Promise<void> = deleteContent

Invokes the content:delete procedure via all clients that support it.

Parameters

cid

ContentIdentifierLike

A valid ContentIdentifierLike value.

instance

Instance

The Instance config to use.

Returns

Promise<void>

A promise that resolves once all requests are completed.

procedures.content:get()

readonly content:get: <T>(cid, instance) => Promise<undefined | T> = getContent

Retrieves an item of content.

Type Parameters

T

T

The type of the content after being parsed.

Parameters

cid

ContentIdentifierLike

A valid ContentIdentifierLike value.

instance

Instance

The instance to use for this request.

Returns

Promise<undefined | T>

A promise that resolves with the parsed content, or undefined if nothing acceptable was found.

procedures.content:put()

readonly content:put: (req, instance) => Promise<void>

Parameters

req

any

instance

Required<InstanceConfig>

Returns

Promise<void>

schemes

readonly schemes: object

schemes.$mut

readonly $mut: ContentIdentifierSchemeParser<FileBuilder<unknown>> = parseAsFile

schemes.$pub

readonly $pub: ContentIdentifierSchemeParser<Identity> = identityScheme

schemes.$ref()

readonly $ref: (cid, content, instance) => Promise<undefined | FileBuilder<unknown>> = Immutable

Parameters

cid

ContentIdentifier

content

Uint8Array<ArrayBufferLike>

instance

Required<InstanceConfig>

Returns

Promise<undefined | FileBuilder<unknown>>

wraps

readonly wraps: object

wraps.ECDSA

ECDSA: WrapModule<ECDSAWrappedMetadata, ECDSAUnwrappedMetadata>

wraps.encrypt

readonly encrypt: WrapModule<EncryptWrapMetadata, EncryptWrapMetadata> = EncryptWrapModule

Example

import { Common } from '@astrobase/sdk/common';
    import { createInstance } from '@astrobase/sdk/instance';

    const instance = createInstance(Common);