Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @ceramicnetwork/http-client

Ceramic http client

An http client for the Ceramic protocol

Getting started

Installation

$ npm install @ceramicnetwork/http-client

Usage

import CeramicClient from '@ceramicnetwork/http-client'
import IdentityWallet from 'identity-wallet'

const API_URL = "http://localhost:7007"

const client = new CeramicClient(API_URL)

// create document example
await doc = await client.createDocument('tile', { content: { test: 123 } })

Ceramic API

Complete Ceramic core API is available on Ceramic API.

Development

Run tests:

$ npm test

Run linter:

npm run lint

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

Variables

Const API_PATH

API_PATH: "/api/v0" = "/api/v0"

Const CERAMIC_HOST

CERAMIC_HOST: "http://localhost:7007" = "http://localhost:7007"

Functions

combineURLs

  • combineURLs(baseURL: any, relativeURL: any): any

delay

  • delay(mills: number): Promise<void>

fetchJson

  • fetchJson(url: string, opts?: FetchOpts): Promise<any>

typeDocID

Object literals

Const DEFAULT_CLIENT_CONFIG

DEFAULT_CLIENT_CONFIG: object

Default Ceramic client configuration

cacheDocCommits

cacheDocCommits: false = false

docCacheLimit

docCacheLimit: number = 500

docSyncEnabled

docSyncEnabled: false = false

docSyncInterval

docSyncInterval: number = 5000