Class BaseSchema<T, S>

Type parameters

T
S

Hierarchy

BaseSchema
- SchemaFactory

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BaseSchema(plain?: Partial<S>, extract?: Extract<keyof S, keyof Common>[]): BaseSchema

- Defined in base.ts:19
Parameters
- Optional plain: Partial<S>
- Default value extract: Extract<keyof S, keyof Common>[] = []
Returns BaseSchema

Properties

context

context: Common = <Common>{}

extract

extract: ("name" | "namespace" | "aliases" | "doc" | "default" | "order")[]

plain

plain: S

type

type: T

Methods

aliases

aliases(...aliases: string[]): this

- Defined in base.ts:69
Set aliases field for the schema

reference

http://avro.apache.org/docs/1.9.2/spec.html#Aliases

Parameters
- Rest ...aliases: string[]
Returns this

copyWith

copyWith(modifyObject: any): this

- Defined in base.ts:105
Make copy of current schema with modified values

Parameters
- modifyObject: any
Returns this

default

default(def: T): this

- Defined in base.ts:87
Set default field for the schema

reference

http://avro.apache.org/docs/1.9.2/spec.html#schema_complex

Parameters
- def: T
Returns this

doc

doc(doc: string): this

- Defined in base.ts:78
Set doc field for the schema

reference

http://avro.apache.org/docs/1.9.2/spec.html#schema_complex

Parameters
- doc: string
Returns this

logicalType

logicalType(logicalType: Required<BaseAvroSchema>["logicalType"], raw?: undefined | { precision: number; scale?: undefined | number }): this
logicalType(logicalType: string, raw?: undefined | object): this
logicalType<N>(logicalType: Required<BaseAvroSchema>["logicalType"], raw?: undefined | { precision: number; scale?: undefined | number }): BaseSchema<N, S>
logicalType<N>(logicalType: string, raw?: undefined | object): BaseSchema<N, S>

- Defined in base.ts:38
Set logical type for the schema

reference

http://avro.apache.org/docs/1.9.2/spec.html#Logical+Types

Parameters
- logicalType: Required<BaseAvroSchema>["logicalType"]
- Optional raw: undefined | { precision: number; scale?: undefined | number }
Returns this
- Defined in base.ts:39
Parameters
- logicalType: string
- Optional raw: undefined | object
Returns this
- Defined in base.ts:40
Type parameters
- N
Parameters
- logicalType: Required<BaseAvroSchema>["logicalType"]
- Optional raw: undefined | { precision: number; scale?: undefined | number }
Returns BaseSchema<N, S>
- Defined in base.ts:41
Type parameters
- N
Parameters
- logicalType: string
- Optional raw: undefined | object
Returns BaseSchema<N, S>

name

name(name: string): this

- Defined in base.ts:51
Set name field for the schema

reference

http://avro.apache.org/docs/1.9.2/spec.html#names

Parameters
- name: string
Returns this

namespace

namespace(namespace: string): this

- Defined in base.ts:60
Set namespace field for the schema

reference

http://avro.apache.org/docs/1.9.2/spec.html#names

Parameters
- namespace: string
Returns this

order

order(order: "ascending" | "descending" | "ignore"): this

- Defined in base.ts:96
Set order field for the record field schema

reference

http://avro.apache.org/docs/1.9.2/spec.html#schema_complex

Parameters
- order: "ascending" | "descending" | "ignore"
Returns this

raw

raw(plain: {}): this

- Defined in base.ts:29
Add custom fields to the schema

Parameters
- plain: {}
Returns this

valueOf

valueOf(): S

- Defined in base.ts:118
It returns the plain schema

Returns S

Generated using TypeDoc