Skip to content

Latest commit

 

History

History
111 lines (62 loc) · 2.36 KB

DefaultTransformer.md

File metadata and controls

111 lines (62 loc) · 2.36 KB

jsonapi-fractal / DefaultTransformer

Class: DefaultTransformer<TEntity, TExtraOptions>

Type parameters

Name Type
TEntity unknown
TExtraOptions void

Hierarchy

  • Transformer<TEntity, TExtraOptions>

    ↳ DefaultTransformer

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new DefaultTransformer<TEntity, TExtraOptions>(type, relationships?)

Type parameters

Name Type
TEntity unknown
TExtraOptions void

Parameters

Name Type Default value
type string undefined
relationships string[] | Record<string, string> []

Overrides

Transformer.constructor

Defined in

src/default-transformer.ts:8

Properties

relationships

• Readonly relationships: Record<string, RelationshipTransformerInfoFunction<TEntity, TExtraOptions>>

Overrides

Transformer.relationships

Defined in

src/default-transformer.ts:6

type

• type: string

Inherited from

Transformer.type

Defined in

src/default-transformer.ts:8

Methods

transform

▸ transform(entity): JsonObject

Parameters

Name Type
entity any

Returns

JsonObject

Overrides

Transformer.transform

Defined in

src/default-transformer.ts:28