Class CodepointStringType

Hierarchy

CodepointStringType

Implements

IoType<string>
VersionedType<string, Diff>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CodepointStringType(options: Lazy<CodepointStringOptions>): CodepointStringType

- Defined in types/codepoint-string.ts:100
Parameters
- options: Lazy<CodepointStringOptions>
Returns CodepointStringType

Properties

Private _options

_options: Lazy<CodepointStringOptions>

enforceUnicodeRegExp

enforceUnicodeRegExp: boolean

lowerCase

lowerCase: boolean

maxCodepoints

maxCodepoints: number

Optional minCodepoints

minCodepoints: undefined | number

name

name: Name = name

normalization

normalization: Normalization

Optional pattern

pattern: RegExp

trimmed

trimmed: boolean

Optional unorm

unorm: UnormLike

Methods

Private _applyOptions

_applyOptions(): void

- Defined in types/codepoint-string.ts:272
Returns void

clone

clone(val: string): string

- Defined in types/codepoint-string.ts:247
Parameters
- val: string
Returns string

diff

diff(oldVal: string, newVal: string): Diff | undefined

- Defined in types/codepoint-string.ts:251
Parameters
- oldVal: string
- newVal: string
Returns Diff | undefined

equals

equals(val1: string, val2: string): boolean

- Defined in types/codepoint-string.ts:243
Parameters
- val1: string
- val2: string
Returns boolean

patch

patch(oldVal: string, diff: Diff | undefined): string

- Defined in types/codepoint-string.ts:255
Parameters
- oldVal: string
- diff: Diff | undefined
Returns string

read

read<R>(reader: Reader<R>, raw: R): string

Implementation of VersionedType.read
- Defined in types/codepoint-string.ts:160
Type parameters
- R
Parameters
- reader: Reader<R>
- raw: R
Returns string

reverseDiff

reverseDiff(diff: Diff | undefined): Diff | undefined

- Defined in types/codepoint-string.ts:259
Parameters
- diff: Diff | undefined
Returns Diff | undefined

squash

squash(diff1: Diff | undefined, diff2: Diff | undefined): Diff | undefined

- Defined in types/codepoint-string.ts:263
Parameters
- diff1: Diff | undefined
- diff2: Diff | undefined
Returns Diff | undefined

test

test(val: string): boolean

- Defined in types/codepoint-string.ts:239
Parameters
- val: string
Returns boolean

testError

testError(val: string): Error | undefined

- Defined in types/codepoint-string.ts:177
Parameters
- val: string
Returns Error | undefined

toJSON

toJSON(): Type

- Defined in types/codepoint-string.ts:141
Returns Type

write

write<W>(writer: Writer<W>, value: string): W

- Defined in types/codepoint-string.ts:173
Type parameters
- W
Parameters
- writer: Writer<W>
- value: string
Returns W

Static fromJSON

fromJSON(options: Type): CodepointStringType

- Defined in types/codepoint-string.ts:124
Parameters
- options: Type
Returns CodepointStringType

Generated using TypeDoc