ContextBuilder.md

jsonapi-fractal / ContextBuilder

Class: ContextBuilder<TEntity, TExtraProperties>

Type parameters

Name	Type
TEntity	TEntity
TExtraProperties	unknown

Table of contents

Constructors

• constructor

Properties

• included
• input
• options
• renderFunction
• transformer

Methods

• serialize
• toContext
• withIncluded
• withInput
• withOptions
• withTransformer

Constructors

constructor

• new ContextBuilder<TEntity, TExtraProperties>(renderFunction)

Type parameters

Name	Type
TEntity	TEntity
TExtraProperties	unknown

Parameters

Name	Type
renderFunction	(c: Context<TEntity, TExtraProperties>) => DocumentObject

Defined in

src/context.ts:18

Properties

included

• included: boolean = false

Defined in

src/context.ts:15

---

input

• Optional input: TEntity

Defined in

src/context.ts:13

---

options

• Optional options: Options<TExtraProperties>

Defined in

src/context.ts:16

---

renderFunction

• Protected renderFunction: (c: Context<TEntity, TExtraProperties>) => DocumentObject

Type declaration

▸ (c): DocumentObject

Parameters

Name	Type
c	Context<TEntity, TExtraProperties>

Returns

DocumentObject

Defined in

src/context.ts:18

---

transformer

• Optional transformer: Transformer<TEntity, TExtraProperties>

Defined in

src/context.ts:14

Methods

serialize

▸ serialize(): DocumentObject

Returns

DocumentObject

Defined in

src/context.ts:60

---

toContext

▸ toContext(): Context<TEntity, TExtraProperties>

Returns

Context<TEntity, TExtraProperties>

Defined in

src/context.ts:43

---

withIncluded

▸ withIncluded(included): ContextBuilder<TEntity, TExtraProperties>

Parameters

Name	Type
included	boolean

Returns

ContextBuilder<TEntity, TExtraProperties>

Defined in

src/context.ts:31

---

withInput

▸ withInput(input): ContextBuilder<TEntity, TExtraProperties>

Parameters

Name	Type
input	TEntity

Returns

ContextBuilder<TEntity, TExtraProperties>

Defined in

src/context.ts:20

---

withOptions

▸ withOptions(options): ContextBuilder<TEntity, TExtraProperties>

Parameters

Name	Type
options	Options<TExtraProperties>

Returns

ContextBuilder<TEntity, TExtraProperties>

Defined in

src/context.ts:37

---

withTransformer

▸ withTransformer(transformer): ContextBuilder<TEntity, TExtraProperties>

Parameters

Name	Type
transformer	Transformer<TEntity, TExtraProperties>

Returns

ContextBuilder<TEntity, TExtraProperties>

Defined in

src/context.ts:25