@orbit/serializers

Classes

• BaseSerializer
• BooleanSerializer
• DateSerializer
• DateTimeSerializer
• NoopSerializer
• NumberSerializer
• StringSerializer

Interfaces

• Serializer
• StringSerializationOptions
• StringSerializerSettings

Type aliases

Inflector

Ƭ Inflector: (input: string) => string

Type declaration

▸ (input): string

Parameters

Name	Type
input	string

Returns

string

Defined in

inflector.ts:3

---

InflectorOrName

Ƭ InflectorOrName: Inflector | StandardInflectorName

Defined in

string-serializer.ts:10

---

SerializerClass

Ƭ SerializerClass<S>: (settings?: unknown) => S

Type parameters

Name	Type
S	Serializer

Type declaration

• (settings?)

Parameters

Name	Type
settings?	unknown

Defined in

serializer.ts:11

---

SerializerClassForFn

Ƭ SerializerClassForFn<S>: (type: string) => SerializerClass<S>

Type parameters

Name	Type
S	Serializer

Type declaration

▸ (type): SerializerClass<S>

Parameters

Name	Type
type	string

Returns

SerializerClass<S>

Defined in

serializer-builders.ts:37

---

SerializerForFn

Ƭ SerializerForFn<S>: (type: string) => S | undefined

Type parameters

Name	Type
S	Serializer

Type declaration

▸ (type): S | undefined

Parameters

Name	Type
type	string

Returns

S | undefined

Defined in

serializer-builders.ts:4

---

SerializerSettingsForFn

Ƭ SerializerSettingsForFn: (type: string) => Dict<unknown> | undefined

Type declaration

▸ (type): Dict<unknown> | undefined

Parameters

Name	Type
type	string

Returns

Dict<unknown> | undefined

Defined in

serializer-builders.ts:47

---

StandardInflectorName

Ƭ StandardInflectorName: "camelize" | "dasherize" | "underscore" | "pluralize" | "singularize"

Defined in

standard-inflectors.ts:64

Variables

standardInflectors

• standardInflectors: Object

Type declaration

Name	Type
camelize	(str: string) => string
dasherize	(str: string) => string
pluralize	(word: string) => string
singularize	(word: string) => string
underscore	(str: string) => string

Defined in

standard-inflectors.ts:71

---

standardInverseInflectors

• standardInverseInflectors: Object

Type declaration

Name	Type
camelize	null
dasherize	string
pluralize	string
singularize	string
underscore	string

Defined in

standard-inflectors.ts:79

Functions

buildInflector

▸ buildInflector(mappings?, fallback?): Inflector

Parameters

Name	Type
mappings	Dict<string>
fallback?	Inflector

Returns

Inflector

Defined in

inflector.ts:5

---

buildSerializerClassFor

▸ buildSerializerClassFor<S>(serializerClasses?): SerializerClassForFn<S>

Type parameters

Name	Type
S	Serializer<unknown, unknown, unknown, unknown>

Parameters

Name	Type
serializerClasses	Dict<SerializerClass<S>>

Returns

SerializerClassForFn<S>

Defined in

serializer-builders.ts:41

---

buildSerializerFor

▸ buildSerializerFor<S>(settings): SerializerForFn<S>

Type parameters

Name	Type
S	Serializer<unknown, unknown, unknown, unknown>

Parameters

Name	Type
settings	Object
settings.serializerClassFor?	SerializerClassForFn<S>
settings.serializerSettingsFor?	SerializerSettingsForFn
settings.serializers?	Dict<S>

Returns

SerializerForFn<S>

Defined in

serializer-builders.ts:6

---

buildSerializerSettingsFor

▸ buildSerializerSettingsFor(settings): SerializerSettingsForFn

Parameters

Name	Type
settings	Object
settings.settingsByType?	Dict<Dict<unknown>>
settings.sharedSettings?	Dict<unknown>

Returns

SerializerSettingsForFn

Defined in

serializer-builders.ts:51

---

camelize

▸ camelize(str): string

Convert underscored, dasherized, or space-delimited words into lowerCamelCase.

Parameters

Name	Type
str	string

Returns

string

Defined in

standard-inflectors.ts:12

---

capitalize

▸ capitalize(str): string

Uppercase the first letter of a string, but don't change the remainder.

Parameters

Name	Type
str	string

Returns

string

Defined in

standard-inflectors.ts:4

---

dasherize

▸ dasherize(str): string

Dasherize words that are underscored, space-delimited, or camelCased.

Parameters

Name	Type
str	string

Returns

string

Defined in

standard-inflectors.ts:32

---

decamelize

▸ decamelize(str): string

Converts a camelized string into all lowercase separated by underscores.

Parameters

Name	Type
str	string

Returns

string

Defined in

standard-inflectors.ts:25

---

pluralize

▸ pluralize(word): string

A naive pluralization method.

Parameters

Name	Type
word	string

Returns

string

Defined in

standard-inflectors.ts:49

---

singularize

▸ singularize(word): string

A naive singularization method.

Parameters

Name	Type
word	string

Returns

string

Defined in

standard-inflectors.ts:56

---

underscore

▸ underscore(str): string

Underscore words that are dasherized, space-delimited, or camelCased.

Parameters

Name	Type
str	string

Returns

string

Defined in

standard-inflectors.ts:39