Class Schemas

Schemas is an API module for managing Textile schemas

extends: API

Hierarchy

API
- Schemas

Index

Constructors

constructor

Methods

Constructors

constructor

new Schemas(opts?: ApiOptions): Schemas

Inherited from API.__constructor
- Defined in core/api.ts:68
Parameters
- Default value opts: ApiOptions = DEFAULT_API_OPTIONS
Returns Schemas

Methods

add

add(schema: object): Promise<FileIndex>

- Defined in modules/schemas/index.ts:37
Creates and validates a new schema from input JSON

Parameters
- schema: object
  
  Input JSON-based thread schema
Returns Promise<FileIndex>

The milled schema as a file index

defaultByName

defaultByName(name: string): Promise<undefined | object>

- Defined in modules/schemas/index.ts:23
Default Textile schemas

Parameters
- name: string
Returns Promise<undefined | object>

An object with various commonly used schemas

defaults

defaults(): Promise<object>

- Defined in modules/schemas/index.ts:15
Default Textile schemas

Returns Promise<object>

An object with various commonly used schemas

get

get(thread: string): Promise<Node>

- Defined in modules/schemas/index.ts:54
Retrieves a schema by thread ID

Parameters
- thread: string
  
  ID of the thread
Returns Promise<Node>

The schema of the target thread