cleave-zen / Exports
- FormatCreditCardOptions
- FormatDateOptions
- FormatGeneralOptions
- FormatNumeralOptions
- FormatTimeOptions
- BlocksType
- CursorTrackerDestructor
- DatePatternType
- DateUnit
- DelimiterType
- RegisterCursorTrackerPropsType
- RequireExactlyOne
- TimeFormatType
- TimePatternType
- TimeUnit
- formatCreditCard
- formatDate
- formatGeneral
- formatNumeral
- formatTime
- getCreditCardType
- registerCursorTracker
- unformatCreditCard
- unformatGeneral
- unformatNumeral
Ƭ BlocksType: number
[]
Ƭ CursorTrackerDestructor: () => void
▸ (): void
void
Ƭ DatePatternType: DateUnit
[]
Ƭ DateUnit: "Y"
| "y"
| "m"
| "d"
Ƭ DelimiterType: string
Ƭ RegisterCursorTrackerPropsType: { input
: HTMLInputElement
; prefix?
: string
} & RequireExactlyOne
<{ delimiter
: DelimiterType
; delimiters
: DelimiterType
[] }, "delimiter"
| "delimiters"
>
Ƭ RequireExactlyOne<T
, Keys
>: { [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>> }[Keys
]
Name | Type |
---|---|
T |
T |
Keys |
extends keyof T = keyof T |
Ƭ TimeFormatType: "12"
| "24"
Ƭ TimePatternType: TimeUnit
[]
Ƭ TimeUnit: "h"
| "m"
| "s"
• Const
DefaultCreditCardDelimiter: DelimiterType
= ' '
• Const
DefaultDateDelimiter: DelimiterType
= '/'
• Const
DefaultNumeralDelimiter: DelimiterType
= ','
• Const
DefaultTimeDelimiter: DelimiterType
= ':'
▸ formatCreditCard(value
, options?
): string
Name | Type |
---|---|
value |
string |
options? |
FormatCreditCardOptions |
string
▸ formatDate(value
, options?
): string
Name | Type |
---|---|
value |
string |
options? |
FormatDateOptions |
string
▸ formatGeneral(value
, options
): string
Name | Type |
---|---|
value |
string |
options |
FormatGeneralOptions |
string
▸ formatNumeral(value
, options?
): string
Name | Type |
---|---|
value |
string |
options? |
FormatNumeralOptions |
string
▸ formatTime(value
, options?
): string
Name | Type |
---|---|
value |
string |
options? |
FormatTimeOptions |
string
▸ getCreditCardType(value
, delimiter?
): CreditCardType
Name | Type |
---|---|
value |
string |
delimiter? |
string |
▸ registerCursorTracker(«destructured»
): CursorTrackerDestructor
Name | Type |
---|---|
«destructured» |
RegisterCursorTrackerPropsType |
▸ unformatCreditCard(value
): string
Name | Type |
---|---|
value |
string |
string
▸ unformatGeneral(value
, options
): string
Name | Type |
---|---|
value |
string |
options |
Pick <FormatGeneralOptions , "delimiters" | "delimiter" > |
string
▸ unformatNumeral(value
, options?
): string
Name | Type |
---|---|
value |
string |
options? |
Pick <FormatNumeralOptions , "numeralDecimalMark" > |
string