SDK Reference
Methods
CreateTileDocument

createTileDocument

A helper method that creates Ceramic TileDocuments.

How to use?

const res = await orbis.createTileDocument(content, tags, schema, family = "orbis", awaitIndex = false);

Parameters

  • content - object containing contents of the JSON to be created (must be serializable)
  • tags - array optional an array of tags to apply to this stream (strings)
  • schema - string optional stream ID of the schema for the stream
  • family - string optional family of which this stream is a part of "orbis" by default
  • awaitIndex - boolean optional whether the method should wait for the stream to be indexed by Orbis Nodes before resolving

Returns

{
    status: 200,
    doc: "k...",
    result: "Success creating TileDocument."
}