Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "index"

Index

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

FieldType

FieldType: "f64" | "f32" | "u32" | "u16" | "u8" | "i32" | "i16" | "i8" | "union" | "struct"

Variables

Const STRUCT

STRUCT: "struct" = "struct"

Const UNION

UNION: "union" = "union"

Functions

Const _sizeOf

  • _sizeOf(spec: Field[], union: boolean, doAlign: boolean, bitOffset: number, total: number): number[]

Const align

  • align(bitOffset: number, type: keyof typeof TYPES | "union" | "struct", spec: any): number

Const bitReader

  • bitReader(dv: DataView, byteOffset: number, bit: number, size: number): (Anonymous function)

Const bitWriter

  • bitWriter(dv: DataView, byteOffset: number, bit: number, size: number): (Anonymous function)

Const isBitField

  • isBitField(f: Field): boolean

Const makeField

  • makeField(field: Field, obj: any, dv: DataView, bitOffset: number, doAlign: boolean, le: boolean): number

Const maybePad

  • maybePad(offset: number, spec: any[], i: number): number

Const sizeOf

  • sizeOf(spec: Field[], union?: boolean, doAlign?: boolean): number

Const struct

  • struct(spec: Field[], buf?: ArrayBuffer | null, offset?: undefined | number, doAlign?: undefined | false | true, le?: undefined | false | true): { __buffer: ArrayBuffer; __offsets: any; __size: number; __spec: Field[] }

  • Parameters

    • spec: Field[]
    • Optional buf: ArrayBuffer | null
    • Optional offset: undefined | number
    • Optional doAlign: undefined | false | true
    • Optional le: undefined | false | true

    Returns { __buffer: ArrayBuffer; __offsets: any; __size: number; __spec: Field[] }

    • __buffer: ArrayBuffer
    • __offsets: any
    • __size: number
    • __spec: Field[]

Const typedef

  • typedef(spec: Field[], struct: boolean, buf?: ArrayBuffer | null, offset?: number, doAlign?: boolean, le?: boolean): { __buffer: ArrayBuffer; __offsets: any; __size: number; __spec: Field[] }

  • Parameters

    • spec: Field[]
    • struct: boolean
    • Optional buf: ArrayBuffer | null
    • Default value offset: number = 0
    • Default value doAlign: boolean = true
    • Default value le: boolean = false

    Returns { __buffer: ArrayBuffer; __offsets: any; __size: number; __spec: Field[] }

    • __buffer: ArrayBuffer
    • __offsets: any
    • __size: number
    • __spec: Field[]

Const union

  • union(spec: Field[], buf?: ArrayBuffer | null, offset?: undefined | number, doAlign?: undefined | false | true, le?: undefined | false | true): { __buffer: ArrayBuffer; __offsets: any; __size: number; __spec: Field[] }

  • Parameters

    • spec: Field[]
    • Optional buf: ArrayBuffer | null
    • Optional offset: undefined | number
    • Optional doAlign: undefined | false | true
    • Optional le: undefined | false | true

    Returns { __buffer: ArrayBuffer; __offsets: any; __size: number; __spec: Field[] }

    • __buffer: ArrayBuffer
    • __offsets: any
    • __size: number
    • __spec: Field[]

Object literals

Const TYPES

TYPES: object

f32

f32: [number, string, false] = [32, "Float", false]

f64

f64: [number, string, false] = [64, "Float", false]

i16

i16: [number, string, true] = [16, "Int", true]

i32

i32: [number, string, true] = [32, "Int", true]

i8

i8: [number, string, true] = [8, "Int", true]

u16

u16: [number, string, false] = [16, "Uint", false]

u32

u32: [number, string, false] = [32, "Uint", false]

u8

u8: [number, string, false] = [8, "Uint", false]

Generated using TypeDoc