Interface SchemaChildNode<T, TypeName>

an abstract and un-typed SchemaNode for the sake of creating an inheritance tree

Type Parameters

  • T extends any = any

  • TypeName extends string = string

Hierarchy

Methods

encode decode setType setName pushChildren setValue setArgs pushArgs

Properties

type value? name? children? args doc?

Methods

Abstract encode

  • describe how an instance of this schema node should be encoded into bytes

    Parameters

    • value: T & {}
    • Rest ...args: []

    Returns Uint8Array

Abstract decode

  • describe bytes from a buffer should decode a value for this schema node

    Parameters

    • buffer: Uint8Array
    • offset: number
    • Rest ...args: []

    Returns Decoded<T & {}, number>

setType

  • manually set this schema's type to the provided type_name, and also register the new type_name to global type_registery if register = true.
    this is the only easy way to register type_names of sub-sub-classes of abstract SchemaNode.
    check out SHeadArray to see how it extends SArray, but registers its own type_name = "headarray" that's different from its parent class's type_name = "array"

    Type Parameters

    • NewTypeName extends string

    Parameters

    • type_name: NewTypeName
    • register: boolean = true

    Returns SchemaChildNode<T, TypeName> & {
        type: NewTypeName;
    }

setName

  • Type Parameters

    • Name extends string

    Parameters

    • name: Name

    Returns SchemaChildNode<T, TypeName> & {
        name: Name;
    }

pushChildren

setValue

setArgs

pushArgs

Properties

type

type: TypeName

a mandatory kind descriptior of the primitive kind

Optional value

value?: T

the value held by this schema node. used as a storage for interceptors to interact and read decoded value
it can also used as a means for storing default values for the encoder to utilize.
but besides those two scenarios, it should typically be left unassigned.
this also comes in handy when annotating types both for the encoder or decoder

Optional name

name?: string

name of the node, used for object property key naming by parent SchemaRecordNode

Optional children

children?: SchemaChildNode<any, string>[]

an array collection of child element. typically used by non-leaf nodes, such as SchemaRecordNode and SchemaTupleNode

args

args: any[] = []

args that should be passed on to either the type specific encoder or decoder

Optional doc

doc?: string | true

an optional doc string for this schema node, that should be cleared when MINIFY is true
to achive that, you would want to write your doc strings as follows:

declare const [DEBUG, MINIFY, BUNDLE]: [boolean, boolean, boolean]
const my_schema_node: SPrimitive<number> {
    type: "u4l",
    doc: MINIFY || "a stupid description of this 32-bit unsinged little piece of endian."
}

Settings

Member Visibility

Theme

Generated using TypeDoc