Class Item<Transformer, Depth, Variant, Fallback>

constructor

• new Item<
      Transformer extends Record<string, any>,
      Depth extends number,
      Variant extends string,
      Fallback,
  >(
      transformerData: any,
      transformer: new (...args: any[]) => Transformer,
      maxDepth: Depth,
      variant: Variant,
      debuggingError: RuntimeException,
      allowNullable?: boolean,
  ): Item<Transformer, Depth, Variant, Fallback>

  Type Parameters

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

  Parameters

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

  Returns Item<Transformer, Depth, Variant, Fallback>

$type

depth

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

  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 Item<Transformer, T, Variant, Fallback>

useVariant

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

  Specify the variant to use for the relationship

  Type Parameters

  • V extends string

  Parameters

  • value: V

  Returns Item<Transformer, Depth, V, Fallback>

notNullable

• notNullable(): Item<Transformer, Depth, Variant, unknown>

  Instruct item to disallow nullable values. An error will be thrown if the value is null.

  Returns Item<Transformer, Depth, Variant, unknown>

transform

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

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

  Parameters

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

  Returns Fallback | Promise<InferData<Transformer, Variant>>