Class CollectionCodecs

constructor

• new CollectionCodecs(): CollectionCodecs

• Returns CollectionCodecs

Static Defaults

Static asCodecClass

• asCodecClass<T>(val, builder?): CollectionCodecClass

• Type Parameters

  • T

  Parameters

  • val: T
  • Optional builder: ((val) => void)
    • • (val): void

      • Parameters

        • val: T & (new (...args) => {
              [$SerializeForCollection]: ((ctx) => SerDesFnRet | "Return ctx.done(val?), ctx.recurse(val?), or ctx.continue(val?)");
          }) & {
              [$DeserializeForCollection]: SerDesFn<CollectionDesCtx>;
          } & {
              prototype: {
                  [$SerializeForCollection]: ((ctx) => SerDesFnRet | "Return ctx.done(val?), ctx.recurse(val?), or ctx.continue(val?)");
              };
          }

        Returns void

  Returns CollectionCodecClass

Static custom

• custom(opts): RawCollCodecs

• Parameters

  • opts: CollCustomCodecOpts

  Returns RawCollCodecs

Static forId

• forId(clazz): RawCollCodecs

• Parameters

  • clazz: CollectionCodecClass

  Returns RawCollCodecs

Static forName

• forName(name, optsOrClass): RawCollCodecs

• Parameters

  • name: string
  • optsOrClass: CollectionCodecClass | CollNominalCodecOpts

  Returns RawCollCodecs

Static forPath

• forPath(path, optsOrClass): RawCollCodecs

• Parameters

  • path: (string | number)[]
  • optsOrClass: CollectionCodecClass | CollNominalCodecOpts

  Returns RawCollCodecs

Static forType

• forType(type, optsOrClass): RawCollCodecs

• Parameters

  • type: string
  • optsOrClass: CollectionCodecClass | CollTypeCodecOpts

  Returns RawCollCodecs