Class Collection<Transformer, Depth, Variant>

constructor

• new Collection<
      Transformer extends Record<string, any>,
      Depth extends number,
      Variant extends string,
  >(
      transformerData: undefined | any[],
      transformer: new (...args: any[]) => Transformer,
      maxDepth: Depth,
      variant: Variant,
      debuggingError: RuntimeException,
  ): Collection<Transformer, Depth, Variant>

  Type Parameters

  • Transformer extends Record<string, any>
  • Depth extends number
  • Variant extends string

  Parameters

  • transformerData: undefined | any[]
  • transformer: new (...args: any[]) => Transformer
  • maxDepth: Depth
  • variant: Variant
  • debuggingError: RuntimeException

  Returns Collection<Transformer, Depth, Variant>

$type

depth

• depth<T extends 1 | 2 | 3 | 4 | 5 | 6>(
      value: T,
  ): Collection<Transformer, T, Variant>

  Specify the depth of relationships to be resolved when creating the object tree.

  Type Parameters

  • T extends 1 | 2 | 3 | 4 | 5 | 6

  Parameters

  • value: T

  Returns Collection<Transformer, T, Variant>

useVariant

• useVariant<V extends string>(value: V): Collection<Transformer, Depth, V>

  Specify the variant to use for the relationship

  Type Parameters

  • V extends string

  Parameters

  • value: V

  Returns Collection<Transformer, Depth, V>

transform

• transform(
      container: ContainerResolver<any>,
      depth: number,
      maxDepth?: number,
  ): Promise<InferData<Transformer, Variant>[]>

  Transforms the resources collection to plain JSON objects. The maxDepth and depth properties can be specified when transforming the collection as a relationship.

  Parameters

  • container: ContainerResolver<any>
  • depth: number
  • OptionalmaxDepth: number

  Returns Promise<InferData<Transformer, Variant>[]>