Class SerializerService

constructor

• new SerializerService(): SerializerService

• Returns SerializerService

dIds

symKeys

symReverseKeys

symValMaps

symValReverseMaps

abbreviate

• abbreviate(consumes, symbolNames, fields?): string[]

• Parameters

  • consumes: Consumes
  • symbolNames: string[]
  • fields: string[] = []

  Returns string[]

compress

• compress(document, ids): StringStringType

• Parameters

  • document: StringStringType
  • ids: string[]

  Returns StringStringType

decompress

• decompress(document, ids): StringStringType

• Parameters

  • document: StringStringType
  • ids: string[]

  Returns StringStringType

export

• export(): SymbolSets

• Returns SymbolSets

getReverseKeyMap

• getReverseKeyMap(keyMap, id?): SymbolMap

• Parameters

  • keyMap: SymbolMap
  • Optionalid: string

  Returns SymbolMap

getReverseValueMap

• getReverseValueMap(valueMap): SymbolMap

• Parameters

  • valueMap: SymbolMap

  Returns SymbolMap

isJobPath

• isJobPath(path): boolean

• Parameters

  • path: string

  Returns boolean

isLiteralKeyType

• isLiteralKeyType(key): boolean

• Parameters

  • key: string

  Returns boolean

package

• package(multiDimensionalDocument, ids): StringStringType

• Parameters

  • multiDimensionalDocument: StringAnyType
  • ids: string[]

  Returns StringStringType

parse

• parse(document): any

• Parameters

  • document: StringStringType

  Returns any

resetSymbols

• resetSymbols(symKeys, symVals, dIds): void

• Parameters

  • symKeys: SymbolSets
  • symVals: Symbols
  • dIds: StringStringType

  Returns void

resolveDimensionalIndex

• resolveDimensionalIndex(path): string

• Parameters

  • path: string

  Returns string

stringify

• stringify(document): StringStringType

• Parameters

  • document: Record<string, any>

  Returns StringStringType

unpackage

• unpackage(document, ids): StringAnyType

• Parameters

  • document: StringStringType
  • ids: string[]

  Returns StringAnyType

StaticfilterSymVals

• filterSymVals(startIndex, maxIndex, existingSymbolValues, proposedValues): Symbols

• Parameters

  • startIndex: number
  • maxIndex: number
  • existingSymbolValues: Symbols
  • proposedValues: Set<string>

  Returns Symbols

StaticfromString

• fromString(value): any

• Parameters

  • value: string

  Returns any

StaticgetCodec

• getCodec(): PayloadCodec

• Returns the currently registered codec, or null if none.

  Returns PayloadCodec

StaticregisterCodec

• registerCodec(codec): void

• Register a global payload codec for encoding/decoding serialized object data. Once registered, all object values are stored as /b{encoded} instead of /s{json}.

  Pass null to remove a previously registered codec.

  Parameters

  • codec: PayloadCodec

  Returns void

  Example

  SerializerService.registerCodec({
    encode(json) { return Buffer.from(json).toString('base64'); },
    decode(encoded) { return Buffer.from(encoded, 'base64').toString('utf8'); },
  });
  Copy

StatictoString

• toString(value): string

• Parameters

  • value: any

  Returns string