sirdez

Type Aliases

ArrayFactory

ArrayFactory: (<T>(sd: Serdes<T>, headSd: Serdes<number>) => Serdes<T[]>)

Type declaration

- <T>(sd: Serdes<T>, headSd: Serdes<number>): Serdes<T[]>
- Type Parameters
  - T
  Parameters
  - sd: Serdes<T>
  - headSd: Serdes<number>
  Returns Serdes<T[]>

BytesFactory

BytesFactory: ((headSd: Serdes<number>) => Serdes<Uint8Array>)

Type declaration

- (headSd: Serdes<number>): Serdes<Uint8Array>
- Parameters
  - headSd: Serdes<number>
  Returns Serdes<Uint8Array>

ClazzFactory

ClazzFactory: (<T, C>(clazz: {}, sd: Serdes<T>) => ClazzSerdes<C>)

Type declaration

- <T, C>(clazz: {}, sd: Serdes<T>): ClazzSerdes<C>
- Type Parameters
  - T
  - C extends T
  Parameters
  - clazz: {}
  - sd: Serdes<T>
  Returns ClazzSerdes<C>

Des

Des<T>: ((ctx: Context) => T)

Type Parameters

Type declaration

- (ctx: Context): T
- Parameters
  - ctx: Context
  Returns T

Encoding

Encoding<T>: { decode: any; encode: any }

Type Parameters

Type declaration

decode:function
- decode(ctx: Context, size: number): T
- - Defined in src/types/serdes.ts:25
  Parameters
  - ctx: Context
  - size: number
  Returns T
encode:function
- encode(ctx: Context, data: T): void
- - Defined in src/types/serdes.ts:24
  Parameters
  - ctx: Context
  - data: T
  Returns void

GetType

GetType<T>: T extends Serdes<infer X> ? X : never

Type Parameters

MapFactory

MapFactory: (<T>(keySd: Serdes<string>, valueSd: Serdes<T>, headSd: Serdes<number>) => Serdes<Record<string, T>>)

Type declaration

- <T>(keySd: Serdes<string>, valueSd: Serdes<T>, headSd: Serdes<number>): Serdes<Record<string, T>>
- Type Parameters
  - T
  Parameters
  - keySd: Serdes<string>
  - valueSd: Serdes<T>
  - headSd: Serdes<number>
  Returns Serdes<Record<string, T>>

OneOf

OneOf<T>: ValueOf<OneOfMap<T>>

Type Parameters

OneOfFactory

OneOfFactory: (<T>(headSd: Serdes<number>, definition: StructDefinition<T>) => Serdes<OneOf<T>>)

Type declaration

- <T>(headSd: Serdes<number>, definition: StructDefinition<T>): Serdes<OneOf<T>>
- Type Parameters
  - T extends Record<string | number | symbol, unknown>
  Parameters
  - headSd: Serdes<number>
  - definition: StructDefinition<T>
  Returns Serdes<OneOf<T>>

OneOfMap

OneOfMap<T>: { [ K in keyof T]: { type: K; value: T[K] } }

Type Parameters

OptionalFactory

OptionalFactory: (<T>(sd: Serdes<T>) => Serdes<T | void>)

Type declaration

- <T>(sd: Serdes<T>): Serdes<T | void>
- Type Parameters
  - T
  Parameters
  - sd: Serdes<T>
  Returns Serdes<T | void>

RecFactory

RecFactory: (<T>(sd: (() => Serdes<T>)) => Serdes<T>)

Type declaration

- <T>(sd: (() => Serdes<T>)): Serdes<T>
- Type Parameters
  - T
  Parameters
  - sd: (() => Serdes<T>)
    - - (): Serdes<T>
      - Returns Serdes<T>
  Returns Serdes<T>

Ser

Ser<T>: ((ctx: Context, data: T) => void)

Type Parameters

Type declaration

- (ctx: Context, data: T): void
- Parameters
  - ctx: Context
  - data: T
  Returns void

StringFactory

StringFactory: ((encoding: Encoding<string>, headSd: Serdes<number>) => Serdes<string>)

Type declaration

- (encoding: Encoding<string>, headSd: Serdes<number>): Serdes<string>
- Parameters
  - encoding: Encoding<string>
  - headSd: Serdes<number>
  Returns Serdes<string>

Struct

Struct: Record<string | number, unknown> | unknown[]

StructDefinition

StructDefinition<T>: { [ k in keyof T]: Serdes<T[k]> }

Type Parameters

T extends Struct

StructFactory

StructFactory: (<T>(definition: StructDefinition<T>) => Serdes<T>)

Type declaration

- <T>(definition: StructDefinition<T>): Serdes<T>
- Type Parameters
  - T extends Struct
  Parameters
  - definition: StructDefinition<T>
  Returns Serdes<T>

TupleFactory

TupleFactory: (<T>(...definition: StructDefinition<T>) => Serdes<T>)

Type declaration

- <T>(...definition: StructDefinition<T>): Serdes<T>
- Type Parameters
  - T extends unknown[]
  Parameters
  - Rest ...definition: StructDefinition<T>
  Returns Serdes<T>

ValueOf

ValueOf<T>: T[keyof T]

Type Parameters

Variables

Const bigInt64

bigInt64: Serdes<bigint> = ...

Const bigUint64

bigUint64: Serdes<bigint> = ...

Const boolean

boolean: Serdes<boolean> = ...

Const float32

float32: Serdes<number> = ...

Const float64

float64: Serdes<number> = ...

Const int16

int16: Serdes<number> = ...

Const int32

int32: Serdes<number> = ...

Const int8

int8: Serdes<number> = ...

Const latin1

latin1: Encoding<string> = ...

Const size

size: Serdes<number> = ...

Const ucs2

ucs2: Encoding<string> = ...

Const uint16

uint16: Serdes<number> = ...

Const uint32

uint32: Serdes<number> = ...

Const uint8

uint8: Serdes<number> = ...

Const usize

usize: Serdes<number> = ...

Const utf8

utf8: Encoding<string> = ...

Const utf8js

utf8js: Encoding<string> = ...

Functions

array

array<T>(sd: Serdes<T>, headSd: Serdes<number>): Serdes<T[]>

- Defined in src/common_serdes/array.ts:4
Type Parameters
- T
Parameters
- sd: Serdes<T>
- headSd: Serdes<number>
Returns Serdes<T[]>

bytes

bytes(headSd: Serdes<number>): Serdes<Uint8Array>

- Defined in src/common_serdes/bytes.ts:4
Parameters
- headSd: Serdes<number>
Returns Serdes<Uint8Array>

clazz

clazz<T, C>(clazz: (new () => C), sd: Serdes<T>): ClazzSerdes<C>

- Defined in src/common_serdes/clazz.ts:12
Type Parameters
- T
- C
Parameters
- clazz: (new () => C)
  - - new (): C
    - Returns C
- sd: Serdes<T>
Returns ClazzSerdes<C>

contextDes

contextDes<T>(ctx: Context, des: Des<T>, bytes: Uint8Array): T

- Defined in src/context.ts:36
Type Parameters
- T
Parameters
- ctx: Context
- des: Des<T>
- bytes: Uint8Array
Returns T

contextFromBytes

contextFromBytes(array: Uint8Array): Context

- Defined in src/context.ts:56
Parameters
- array: Uint8Array
Returns Context

contextSer

contextSer<T>(ctx: Context, ser: Ser<T>, data: T): Uint8Array

- Defined in src/context.ts:17
Type Parameters
- T
Parameters
- ctx: Context
- ser: Ser<T>
- data: T
Returns Uint8Array

createContext

createContext(size?: number): Context

- Defined in src/context.ts:3
Parameters
- size: number = 4096
Returns Context

define

define<T>(ser: Ser<T>, des: Des<T>): Serdes<T>

- Defined in src/define.ts:3
Type Parameters
- T
Parameters
- ser: Ser<T>
- des: Des<T>
Returns Serdes<T>

growContext

growContext(ctx: Context): void

- Defined in src/context.ts:12
Parameters
- ctx: Context
Returns void

map

map<T>(keySd: Serdes<string>, valueSd: Serdes<T>, headSd: Serdes<number>): Serdes<Record<string, T>>

- Defined in src/common_serdes/map.ts:4
Type Parameters
- T
Parameters
- keySd: Serdes<string>
- valueSd: Serdes<T>
- headSd: Serdes<number>
Returns Serdes<Record<string, T>>

msgpack

msgpack(encoding: Encoding<string>, single?: boolean): Serdes<unknown>

- Defined in src/msgpack/index.ts:9
Parameters
- encoding: Encoding<string>
- single: boolean = false
Returns Serdes<unknown>

number

number(kind: IntKind, bitSize: IntSize): Serdes<number>
number(kind: "float", bitSize: FloatSize): Serdes<number>
number(kind: BigIntKind, bitSize: 64): Serdes<bigint>
number(kind: Kind, bitSize: Size): Serdes<never>

- Defined in src/serdes/number.ts:123
Parameters
- kind: IntKind
- bitSize: IntSize
Returns Serdes<number>
- Defined in src/serdes/number.ts:123
Parameters
- kind: "float"
- bitSize: FloatSize
Returns Serdes<number>
- Defined in src/serdes/number.ts:123
Parameters
- kind: BigIntKind
- bitSize: 64
Returns Serdes<bigint>
- Defined in src/serdes/number.ts:123
Parameters
- kind: Kind
- bitSize: Size
Returns Serdes<never>

oneOf

oneOf<T>(headSd: Serdes<number>, definition: StructDefinition<T>): Serdes<OneOf<T>>

- Defined in src/common_serdes/one_of.ts:10
Type Parameters
- T extends Record<string | number | symbol, unknown>
Parameters
- headSd: Serdes<number>
- definition: StructDefinition<T>
Returns Serdes<OneOf<T>>

optional

optional<T>(sd: Serdes<T>): Serdes<void | T>

- Defined in src/common_serdes/optional.ts:4
Type Parameters
- T
Parameters
- sd: Serdes<T>
Returns Serdes<void | T>

rec

rec<T>(sd: (() => Serdes<T>)): Serdes<T>

- Defined in src/common_serdes/rec.ts:6
Type Parameters
- T
Parameters
- sd: (() => Serdes<T>)
  - - (): Serdes<T>
    - Returns Serdes<T>
Returns Serdes<T>

string

string(encoding: Encoding<string>, headSd: Serdes<number>): Serdes<string>

- Defined in src/common_serdes/string.ts:4
Parameters
- encoding: Encoding<string>
- headSd: Serdes<number>
Returns Serdes<string>

struct

struct<T>(definition: StructDefinition<T>): Serdes<T>

- Defined in src/serdes/struct.ts:3
Type Parameters
- T extends Struct
Parameters
- definition: StructDefinition<T>
Returns Serdes<T>

tuple

tuple<T>(...definition: StructDefinition<T>): Serdes<T>

- Defined in src/serdes/struct.ts:22
Type Parameters
- T extends unknown[]
Parameters
- Rest ...definition: StructDefinition<T>
Returns Serdes<T>

use

use<T>(__namedParameters: Serdes<T>, size?: number): UsableSerdes<T>

- Defined in src/use.ts:9
Type Parameters
- T
Parameters
- __namedParameters: Serdes<T>
- Optional size: number
Returns UsableSerdes<T>

Index

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

ArrayFactory

Type declaration

Type Parameters

T

Parameters

sd: Serdes<T>

headSd: Serdes<number>

Returns Serdes<T[]>

BytesFactory

Type declaration

Parameters

headSd: Serdes<number>

Returns Serdes<Uint8Array>

ClazzFactory

Type declaration

Type Parameters

T

C extends T

Parameters

clazz: {}

sd: Serdes<T>

Returns ClazzSerdes<C>

Des

Type Parameters

T

Type declaration

Parameters

ctx: Context

Returns T

Encoding

Type Parameters

T

Type declaration

decode:function

Parameters

ctx: Context

size: number

Returns T

encode:function

Parameters

ctx: Context

data: T

Returns void

GetType

Type Parameters

T

MapFactory

Type declaration

Type Parameters

T

Parameters

keySd: Serdes<string>

valueSd: Serdes<T>

headSd: Serdes<number>

Returns Serdes<Record<string, T>>

OneOf

Type Parameters

T

OneOfFactory

Type declaration

Type Parameters

T extends Record<string | number | symbol, unknown>

Parameters

headSd: Serdes<number>

definition: StructDefinition<T>

Returns Serdes<OneOf<T>>

OneOfMap

Type Parameters

T

OptionalFactory

Type declaration

Type Parameters

T