booking / vendors / imask / esm / masked / pattern.d.ts

pattern.d.ts in Booking Calendar 11.8, at vendors/imask/esm/masked/pattern.d.ts

103 lines 4.1 KB

Raw Download Zip

1	import ChangeDetails from '../core/change-details';
2	import { type TailDetails } from '../core/tail-details';
3	import { type Direction } from '../core/utils';
4	import Masked, { type AppendFlags, type ExtractFlags, type MaskedOptions, type MaskedState } from './base';
5	import { type FactoryArg, type ExtendFactoryArgOptions } from './factory';
6	import type PatternBlock from './pattern/block';
7	import PatternFixedDefinition from './pattern/fixed-definition';
8	import PatternInputDefinition from './pattern/input-definition';
9	import './regexp';
10	export type MaskedPatternOptions<Value = string, M extends MaskedPattern<Value> = MaskedPattern<Value>, Props extends keyof M = never> = MaskedOptions<M, 'definitions' \| 'blocks' \| 'placeholderChar' \| 'displayChar' \| 'lazy' \| Props>;
11	export type Definitions = {
12	[k: string]: FactoryArg;
13	};
14	export type MaskedPatternState = MaskedState & {
15	_blocks: Array<MaskedState>;
16	};
17	export type BlockPosData = {
18	index: number;
19	offset: number;
20	};
21	export type BlockExtraOptions = {
22	expose?: boolean;
23	repeat?: number \| [number, number];
24	};
25	/** Pattern mask */
26	export default class MaskedPattern<Value = string> extends Masked<Value> {
27	static DEFAULTS: {
28	lazy: boolean;
29	placeholderChar: string;
30	skipInvalid?: boolean \| undefined;
31	};
32	static STOP_CHAR: string;
33	static ESCAPE_CHAR: string;
34	static InputDefinition: typeof PatternInputDefinition;
35	static FixedDefinition: typeof PatternFixedDefinition;
36	mask: string;
37	/** */
38	blocks: {
39	[key: string]: ExtendFactoryArgOptions<BlockExtraOptions>;
40	};
41	/** */
42	definitions: Definitions;
43	/** Single char for empty input */
44	placeholderChar: string;
45	/** Single char for filled input */
46	displayChar: string;
47	/** Show placeholder only when needed */
48	lazy: boolean;
49	/** Enable characters overwriting */
50	overwrite?: boolean \| 'shift' \| undefined;
51	/** */
52	eager?: boolean \| 'remove' \| 'append' \| undefined;
53	/** */
54	skipInvalid?: boolean \| undefined;
55	/** */
56	autofix?: boolean \| 'pad' \| undefined;
57	_blocks: Array<PatternBlock>;
58	_maskedBlocks: {
59	[key: string]: Array<number>;
60	};
61	_stops: Array<number>;
62	exposeBlock?: Masked;
63	constructor(opts: MaskedPatternOptions<Value>);
64	updateOptions(opts: Partial<MaskedPatternOptions<Value>>): void;
65	_update(opts: Partial<MaskedPatternOptions<Value>>): void;
66	_rebuildMask(): void;
67	get state(): MaskedPatternState;
68	set state(state: MaskedPatternState);
69	reset(): void;
70	get isComplete(): boolean;
71	get isFilled(): boolean;
72	get isFixed(): boolean;
73	get isOptional(): boolean;
74	doCommit(): void;
75	get unmaskedValue(): string;
76	set unmaskedValue(unmaskedValue: string);
77	get value(): string;
78	set value(value: string);
79	get typedValue(): Value;
80	set typedValue(value: Value);
81	get displayValue(): string;
82	appendTail(tail: string \| String \| TailDetails): ChangeDetails;
83	_appendEager(): ChangeDetails;
84	_appendCharRaw(ch: string, flags?: AppendFlags<MaskedPatternState>): ChangeDetails;
85	extractTail(fromPos?: number, toPos?: number): TailDetails;
86	extractInput(fromPos?: number, toPos?: number, flags?: ExtractFlags): string;
87	_findStopBefore(blockIndex: number): number \| undefined;
88	/** Appends placeholder depending on laziness */
89	_appendPlaceholder(toBlockIndex?: number): ChangeDetails;
90	/** Finds block in pos */
91	_mapPosToBlock(pos: number): BlockPosData \| undefined;
92	_blockStartPos(blockIndex: number): number;
93	_forEachBlocksInRange(fromPos: number, toPos: number \| undefined, fn: (block: PatternBlock, blockIndex: number, fromPos: number, toPos: number) => void): void;
94	remove(fromPos?: number, toPos?: number): ChangeDetails;
95	nearestInputPos(cursorPos: number, direction?: Direction): number;
96	totalInputPositions(fromPos?: number, toPos?: number): number;
97	/** Get block by name */
98	maskedBlock(name: string): PatternBlock \| undefined;
99	/** Get all blocks by name */
100	maskedBlocks(name: string): Array<PatternBlock>;
101	pad(flags?: AppendFlags): ChangeDetails;
102	}
103	//# sourceMappingURL=pattern.d.ts.map