SchemaFactory | avroschema-definer

Type parameters

Hierarchy

BaseSchema
- SchemaFactory

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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

Properties

context

context: Common = <Common>{}

extract

plain

plain: S

type

type: T

Methods

aliases

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

Inherited from BaseSchema.aliases
- 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

array

array<T>(items: T): BaseSchema<T["type"][], ArrayAvroSchema>

- Defined in index.ts:138
Complex type. Correspond to array of specified type

example

{ "type": "array", "items": { type: "string" } }

reference

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

Type parameters
- T: BaseSchema
Parameters
- items: T
Returns BaseSchema<T["type"][], ArrayAvroSchema>

boolean

boolean(): BaseSchema<boolean, BaseAvroSchema>

- Defined in index.ts:28
Primitive type. Corresponds to a binary value

example

{ "type": "boolean" }

reference

https://avro.apache.org/docs/1.9.2/spec.html#schema_primitive

Returns BaseSchema<boolean, BaseAvroSchema>

bytes

bytes(): BaseSchema<Buffer, BaseAvroSchema>

- Defined in index.ts:83
Primitive type. Corresponds to sequence of 8-bit unsigned bytes

example

{ "type": "bytes" }

reference

https://avro.apache.org/docs/1.9.2/spec.html#schema_primitive

Returns BaseSchema<Buffer, BaseAvroSchema>

copyWith

copyWith(modifyObject: any): this

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

Parameters
- modifyObject: any
Returns this

default

default(def: T): this

Inherited from BaseSchema.default
- 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

Inherited from BaseSchema.doc
- 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

double

double(): BaseSchema<number, BaseAvroSchema>

- Defined in index.ts:72
Primitive type. Corresponds to double precision (64-bit) IEEE 754 floating-point number

example

{ "type": "double" }

reference

https://avro.apache.org/docs/1.9.2/spec.html#schema_primitive

Returns BaseSchema<number, BaseAvroSchema>

enum

enum<T>(...symbols: T): BaseSchema<T[number], EnumAvroSchema>

- Defined in index.ts:124
Complex type. Correspond to enumerated type of strings

example

{ "type": "enum", "symbols": [ "some", "any" ] }

reference

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

Type parameters
- T: string[]
Parameters
- Rest ...symbols: T
Returns BaseSchema<T[number], EnumAvroSchema>

fixed

fixed(size: number): BaseSchema<Buffer, FixedAvroSchema>

- Defined in index.ts:164
Complex type. Correspond to the given number of bytes per value

example

{ "type": "fixed", "size": 16 }

reference

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

Parameters
- size: number
Returns BaseSchema<Buffer, FixedAvroSchema>

float

float(): BaseSchema<number, BaseAvroSchema>

- Defined in index.ts:61
Primitive type. Corresponds to single precision (32-bit) IEEE 754 floating-point number

example

{ "type": "float" }

reference

https://avro.apache.org/docs/1.9.2/spec.html#schema_primitive

Returns BaseSchema<number, BaseAvroSchema>

int

int(): BaseSchema<number, BaseAvroSchema>

- Defined in index.ts:39
Primitive type. Corresponds to 32-bit signed integer

example

{ "type": "int" }

reference

https://avro.apache.org/docs/1.9.2/spec.html#schema_primitive

Returns BaseSchema<number, BaseAvroSchema>

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>

Inherited from BaseSchema.logicalType
- 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
Inherited from BaseSchema.logicalType
- Defined in base.ts:39
Parameters
- logicalType: string
- Optional raw: undefined | object
Returns this
Inherited from BaseSchema.logicalType
- 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>
Inherited from BaseSchema.logicalType
- Defined in base.ts:41
Type parameters
- N
Parameters
- logicalType: string
- Optional raw: undefined | object
Returns BaseSchema<N, S>

long

long(): BaseSchema<number, BaseAvroSchema>

- Defined in index.ts:50
Primitive type. Corresponds to 64-bit signed integer

example

{ "type": "long" }

reference

https://avro.apache.org/docs/1.9.2/spec.html#schema_primitive

Returns BaseSchema<number, BaseAvroSchema>

map

map<T>(values: T): BaseSchema<{}, MapAvroSchema>

- Defined in index.ts:151
Complex type. Correspond to map of specified type

example

{ "type": "map", "values": { type: "string" } }

reference

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

Type parameters
- T: BaseSchema
Parameters
- values: T
Returns BaseSchema<{}, MapAvroSchema>

name

name(name: string): this

Inherited from BaseSchema.name
- 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

Inherited from BaseSchema.namespace
- 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

null

null(): BaseSchema<null, BaseAvroSchema>

- Defined in index.ts:17
Primitive type. Corresponds to no value

example

{ "type": "null" }

reference

https://avro.apache.org/docs/1.9.2/spec.html#schema_primitive

Returns BaseSchema<null, BaseAvroSchema>

order

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

Inherited from BaseSchema.order
- 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

Inherited from BaseSchema.raw
- Defined in base.ts:29
Add custom fields to the schema

Parameters
- plain: {}
Returns this

record

record<T>(record: T): BaseSchema<{}, RecordAvroSchema>

- Defined in index.ts:105
Complex type. Correspond to record of values keyed by strings

example

{ "type": "record", "fields": [ { "name": "value", "type": "long" } ] }

reference

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

Type parameters
- T: Record<string, BaseSchema<any, any>>
Parameters
- record: T
Returns BaseSchema<{}, RecordAvroSchema>

string

string(): BaseSchema<string, BaseAvroSchema>

- Defined in index.ts:94
Primitive type. Corresponds to unicode character sequence

example

{ "type": "string" }

reference

https://avro.apache.org/docs/1.9.2/spec.html#schema_primitive

Returns BaseSchema<string, BaseAvroSchema>

union

union<T>(...args: T): BaseSchema<T[number]["type"], BaseAvroSchema[]>

- Defined in index.ts:178
Complex type. Correspond to the value which may be one of given types

example

["null", "string"]

reference

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

Type parameters
- T: BaseSchema[]
Parameters
- Rest ...args: T
Returns BaseSchema<T[number]["type"], BaseAvroSchema[]>

valueOf

valueOf(): S

Inherited from BaseSchema.valueOf
- Defined in base.ts:118
It returns the plain schema

Returns S

Type parameters

T

S

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional plain: Partial<S>

Default value extract: Extract<keyof S, keyof Common>[] = []

Returns SchemaFactory

Properties

context

extract

plain

type

Methods

aliases

Parameters

Rest ...aliases: string[]

Returns this

array

Type parameters

T: BaseSchema

Parameters

items: T

Returns BaseSchema<T["type"][], ArrayAvroSchema>

boolean

Returns BaseSchema<boolean, BaseAvroSchema>

bytes

Returns BaseSchema<Buffer, BaseAvroSchema>

copyWith

Parameters

modifyObject: any

Returns this

default

Parameters

def: T

Returns this

doc

Parameters

doc: string

Returns this

double

Returns BaseSchema<number, BaseAvroSchema>

enum

Type parameters

T: string[]

Parameters

Rest ...symbols: T

Returns BaseSchema<T[number], EnumAvroSchema>

fixed

Parameters

size: number

Returns BaseSchema<Buffer, FixedAvroSchema>

float

Returns BaseSchema<number, BaseAvroSchema>

int

Returns BaseSchema<number, BaseAvroSchema>

logicalType

Parameters

logicalType: Required<BaseAvroSchema>["logicalType"]

Optional raw: undefined | { precision: number; scale?: undefined | number }

Returns this

Parameters

logicalType: string

Optional raw: undefined | object

Returns this

Type parameters

N

Parameters

logicalType: Required<BaseAvroSchema>["logicalType"]

Optional raw: undefined | { precision: number; scale?: undefined | number }

Returns BaseSchema<N, S>

Type parameters

N

Parameters