Class StructuredWriter

Base class for json, qs and bson writers.

Hierarchy

StructuredWriter

Implements

Writer<any>

Index

Methods

Methods

writeAny

writeAny(value: any): any

Implementation of Writer.writeAny
- Defined in writers/structured.ts:23
Parameters
- value: any
Returns any

Abstract writeBoolean

writeBoolean(value: boolean): any

Implementation of Writer.writeBoolean
- Defined in writers/structured.ts:11
Parameters
- value: boolean
Returns any

Abstract writeBytes

writeBytes(value: Uint8Array): any

Implementation of Writer.writeBytes
- Defined in writers/structured.ts:19
Parameters
- value: Uint8Array
Returns any

Abstract writeDate

writeDate(value: Date): any

Implementation of Writer.writeDate
- Defined in writers/structured.ts:13
Parameters
- value: Date
Returns any

writeDocument

writeDocument<K>(keys: Iterable<K>, handler: function): Record<K, any>

- Defined in writers/structured.ts:35
Type parameters
- K: string
Parameters
- keys: Iterable<K>
- handler: function
  - - (key: K, fieldWriter: Writer<any>): any
    - Parameters
      - key: K
      - fieldWriter: Writer<any>
      Returns any
Returns Record<K, any>

Abstract writeFloat64

writeFloat64(value: number): any

Implementation of Writer.writeFloat64
- Defined in writers/structured.ts:15
Parameters
- value: number
Returns any

writeList

writeList(size: number, handler: function): any[]

- Defined in writers/structured.ts:27
Parameters
- size: number
- handler: function
  - - (index: number, itemWriter: Writer<any>): any
    - Parameters
      - index: number
      - itemWriter: Writer<any>
      Returns any
Returns any[]

Abstract writeMap

writeMap(size: number, keyHandler: function, valueHandler: function): any

- Defined in writers/structured.ts:46
Parameters
- size: number
- keyHandler: function
  - - <KW>(index: number, mapKeyWriter: Writer<KW>): KW
    - Type parameters
      - KW
      Parameters
      - index: number
      - mapKeyWriter: Writer<KW>
      Returns KW
- valueHandler: function
  - - <VW>(index: number, mapValueWriter: Writer<VW>): VW
    - Type parameters
      - VW
      Parameters
      - index: number
      - mapValueWriter: Writer<VW>
      Returns VW
Returns any

Abstract writeNull

writeNull(): any

Implementation of Writer.writeNull
- Defined in writers/structured.ts:21
Returns any

Abstract writeString

writeString(value: string): any

Implementation of Writer.writeString
- Defined in writers/structured.ts:17
Parameters
- value: string
Returns any

Generated using TypeDoc