cleave-zen

December 16, 2023 · View on GitHub

cleave-zen / Exports

cleave-zen

Table of contents

Enumerations

Interfaces

Type Aliases

Variables

Functions

Type Aliases

BlocksType

Ƭ BlocksType: number[]

Defined in

common/types.ts:6

CursorTrackerDestructor

Ƭ CursorTrackerDestructor: () => void

Type declaration

▸ (): void

Returns

void

Defined in

cursor-tracker/types.ts:3

DatePatternType

Ƭ DatePatternType: DateUnit[]

Defined in

date/types.ts:4

DateUnit

Ƭ DateUnit: "Y" | "y" | "m" | "d"

Defined in

date/types.ts:3

DelimiterType

Ƭ DelimiterType: string

Defined in

common/types.ts:5

RegisterCursorTrackerPropsType

Ƭ RegisterCursorTrackerPropsType: { input: HTMLInputElement ; prefix?: string } & RequireExactlyOne<{ delimiter: DelimiterType ; delimiters: DelimiterType[] }, "delimiter" | "delimiters">

Defined in

cursor-tracker/types.ts:5

RequireExactlyOne

Ƭ RequireExactlyOne<T, Keys>: { [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>> }[Keys]

Type parameters

Name	Type
`T`	`T`
`Keys`	extends keyof `T` = keyof `T`

Defined in

common/types.ts:1

TimeFormatType

Ƭ TimeFormatType: "12" | "24"

Defined in

time/types.ts:5

TimePatternType

Ƭ TimePatternType: TimeUnit[]

Defined in

time/types.ts:4

TimeUnit

Ƭ TimeUnit: "h" | "m" | "s"

Defined in

time/types.ts:3

Variables

DefaultCreditCardDelimiter

• Const DefaultCreditCardDelimiter: DelimiterType = ' '

Defined in

credit-card/constants.ts:4

DefaultDateDelimiter

• Const DefaultDateDelimiter: DelimiterType = '/'

Defined in

date/constants.ts:4

DefaultNumeralDelimiter

• Const DefaultNumeralDelimiter: DelimiterType = ','

Defined in

numeral/constants.ts:9

DefaultTimeDelimiter

• Const DefaultTimeDelimiter: DelimiterType = ':'

Defined in

time/constants.ts:5

Functions

formatCreditCard

▸ formatCreditCard(value, options?): string

Parameters

Name	Type
`value`	`string`
`options?`	`FormatCreditCardOptions`

Returns

string

Defined in

credit-card/index.ts:61

formatDate

▸ formatDate(value, options?): string

Parameters

Name	Type
`value`	`string`
`options?`	`FormatDateOptions`

Returns

string

Defined in

date/index.ts:288

formatGeneral

▸ formatGeneral(value, options): string

Parameters

Name	Type
`value`	`string`
`options`	`FormatGeneralOptions`

Returns

string

Defined in

general/index.ts:37

formatNumeral

▸ formatNumeral(value, options?): string

Parameters

Name	Type
`value`	`string`
`options?`	`FormatNumeralOptions`

Returns

string

Defined in

numeral/index.ts:112

formatTime

▸ formatTime(value, options?): string

Parameters

Name	Type
`value`	`string`
`options?`	`FormatTimeOptions`

Returns

string

Defined in

time/index.ts:190

getCreditCardType

▸ getCreditCardType(value, delimiter?): CreditCardType

Parameters

Name	Type
`value`	`string`
`delimiter?`	`string`

Returns

CreditCardType

Defined in

credit-card/index.ts:100

registerCursorTracker

▸ registerCursorTracker(«destructured»): CursorTrackerDestructor

Parameters

Name	Type
`«destructured»`	`RegisterCursorTrackerPropsType`

Returns

CursorTrackerDestructor

Defined in

cursor-tracker/index.ts:43

unformatCreditCard

▸ unformatCreditCard(value): string

Parameters

Name	Type
`value`	`string`

Returns

string

Defined in

credit-card/index.ts:116

unformatGeneral

▸ unformatGeneral(value, options): string

Parameters

Name	Type
`value`	`string`
`options`	`Pick`<`FormatGeneralOptions`, `"delimiters"` \| `"delimiter"`>

Returns

string

Defined in

general/index.ts:99

unformatNumeral

▸ unformatNumeral(value, options?): string

Parameters

Name	Type
`value`	`string`
`options?`	`Pick`<`FormatNumeralOptions`, `"numeralDecimalMark"`>

Returns

string

Defined in

numeral/index.ts:146