Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @ceramicnetwork/common

Ceramic Common

This package contains common Ceramic types and utilities.

Installation

 
$ npm install @ceramicnetwork/common

Contributing

We are happy to accept small and large contributions. Make sure to check out the Ceramic specifications for details of how the protocol works.

License

Index

References

Enumerations

Classes

Interfaces

Type aliases

Functions

Object literals

References

AnchorCommit

Re-exports AnchorCommit

AnchorProof

Re-exports AnchorProof

AnchorService

Re-exports AnchorService

AnchorStatus

Re-exports AnchorStatus

CeramicApi

Re-exports CeramicApi

CeramicCommit

Re-exports CeramicCommit

CidList

Re-exports CidList

CidString

Re-exports CidString

CommitHeader

Re-exports CommitHeader

CommitType

Re-exports CommitType

Context

Re-exports Context

Designator

Re-exports Designator

DocCache

Re-exports DocCache

DocMetadata

Re-exports DocMetadata

DocNext

Re-exports DocNext

DocOpts

Re-exports DocOpts

DocParams

Re-exports DocParams

DocState

Re-exports DocState

DocStateHolder

Re-exports DocStateHolder

Doctype

Re-exports Doctype

DoctypeConstructor

Re-exports DoctypeConstructor

DoctypeHandler

Re-exports DoctypeHandler

DoctypeStatic

Re-exports DoctypeStatic

DoctypeUtils

Re-exports DoctypeUtils

GenesisCommit

Re-exports GenesisCommit

GenesisHeader

Re-exports GenesisHeader

LogEntry

Re-exports LogEntry

LoggerOptions

Renames and exports Options

LoggerOptions

Renames and exports Options

LoggerPlugin

Renames and exports Plugin

LoggerPlugin

Renames and exports Plugin

LoggerPluginOptions

Renames and exports PluginOptions

LoggerPluginOptions

Renames and exports PluginOptions

LoggerProvider

Re-exports LoggerProvider

MultiQuery

Re-exports MultiQuery

PinApi

Re-exports PinApi

PinningBackend

Re-exports PinningBackend

PinningBackendStatic

Re-exports PinningBackendStatic

PinningInfo

Re-exports PinningInfo

SignatureStatus

Re-exports SignatureStatus

SignedCommit

Re-exports SignedCommit

SignedCommitContainer

Re-exports SignedCommitContainer

UnsignedCommit

Re-exports UnsignedCommit

Type aliases

CeramicCommit

CeramicCommit: GenesisCommit | UnsignedCommit | AnchorCommit | SignedCommit | SignedCommitContainer

CidList

CidList: Record<CidString, Designator[]>

CidString

CidString: string

Designator

Designator: string

GenesisCommit

GenesisCommit: { data?: any; header: GenesisHeader; unique?: string }

Type declaration

  • Optional data?: any
  • header: GenesisHeader
  • Optional unique?: string

GenesisHeader

GenesisHeader: CommitHeader

IpfsApi

IpfsApi: typeof IpfsApi

PinningInfo

PinningInfo: Record<string, any>

Plugin

Plugin: (rootLogger: RootLogger, pluginState?: any, loggerOptions?: Options, pluginOptions?: PluginOptions) => void

Function type for plugins

dev

Must call setLevel on rootLogger to be enabled

Type declaration

    • (rootLogger: RootLogger, pluginState?: any, loggerOptions?: Options, pluginOptions?: PluginOptions): void

    • Parameters

      • rootLogger: RootLogger
      • Optional pluginState: any
      • Optional loggerOptions: Options
      • Optional pluginOptions: PluginOptions

      Returns void

SignedCommit

SignedCommit: DagJWS

SignedCommitContainer

SignedCommitContainer: DagJWSResult

Functions

DoctypeStatic

  • DoctypeStatic<T>(): (Anonymous function)

Object literals

Const defaultOpts

defaultOpts: object

Default logger options

format

format: string = "text"

level

level: string = "info"

stacktrace

stacktrace: object

depth

depth: 3 = 3

excess

excess: 0 = 0

levels

levels: ["trace", "warn", "error"] = ['trace', 'warn', 'error']