strings | @pagopa/ts-commons

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

CIDR

CIDR: t.TypeOf<typeof CIDR>

EmailString

EmailString: t.TypeOf<typeof EmailString>

FiscalCode

FiscalCode: t.TypeOf<typeof FiscalCode>

IPString

IPString: t.TypeOf<typeof IPString>

NonEmptyString

NonEmptyString: t.TypeOf<typeof NonEmptyString>

OrganizationFiscalCode

OrganizationFiscalCode: t.TypeOf<typeof OrganizationFiscalCode>

PatternString

PatternString<P>: string & IPatternStringTag<P>

Type parameters

P: string

SandboxFiscalCode

SandboxFiscalCode: t.TypeOf<typeof SandboxFiscalCode>

WithinRangeString

WithinRangeString<L, H>: string & IWithinRangeStringTag<L, H>

Type parameters

L: number
H: number

Variables

Const CIDR

CIDR: Tagged<IPatternStringTag<string>, string, string, unknown> = ...

A string that represents a valid CIDR.

Const EmailString

EmailString: Tagged<IEmailStringTag, string, string, unknown> = ...

A string that represents a valid email address.

Const FiscalCode

FiscalCode: Tagged<IPatternStringTag<"^[A-Z]{6}[0-9LMNPQRSTUV]{2}[ABCDEHLMPRST][0-9LMNPQRSTUV]{2}[A-Z][0-9LMNPQRSTUV]{3}[A-Z]$">, string, string, unknown> = ...

A valid Fiscal Number (for persons)

Const IPString

IPString: Tagged<IIPStringTag, string, string, unknown> = ...

A string that represents an IP (v4 or v6).

Const NonEmptyString

NonEmptyString: Tagged<INonEmptyStringTag, string, string, unknown> = ...

A non-empty string

Const OrganizationFiscalCode

OrganizationFiscalCode: Tagged<IPatternStringTag<"^[0-9]{11}$">, string, string, unknown> = ...

A valid Fiscal Number (for organizations)

Const SandboxFiscalCode

SandboxFiscalCode: Tagged<IPatternStringTag<"^[A-Z]{6}[0-9]{2}A[0-9]{2}Y[0-9]{3}X$">, string, string, unknown> = ...

A sandbox Fiscal Code (used for development) Note that this pattern doesn't generate valid fiscal codes

Functions

Const PatternString

PatternString<P, T>(p: P): Tagged<T, string, string, unknown>

- Defined in src/strings.ts:55
A string that matches a pattern.

Type parameters
- P: string
- T: IPatternStringTag<P, T>
Parameters
- p: P
Returns Tagged<T, string, string, unknown>

Const WithinRangeString

WithinRangeString<L, H, T>(l: L, h: H): Tagged<T, string, string, unknown>

- Defined in src/strings.ts:28
A string guaranteed to have a length within the range [L,H)

Type parameters
- L: number
- H: number
- T: IWithinRangeStringTag<L, H, T>
Parameters
- l: L
- h: H
Returns Tagged<T, string, string, unknown>

Generated using TypeDoc

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

CIDR

EmailString

FiscalCode

IPString

NonEmptyString

OrganizationFiscalCode

PatternString

Type parameters

P: string

SandboxFiscalCode

WithinRangeString

Type parameters

L: number

H: number

Variables

Const CIDR

Const EmailString

Const FiscalCode

Const IPString

Const NonEmptyString

Const OrganizationFiscalCode

Const SandboxFiscalCode

Functions

Const PatternString

Type parameters

P: string

T: IPatternStringTag<P, T>

Parameters

p: P

Returns Tagged<T, string, string, unknown>

Const WithinRangeString

Type parameters

L: number

H: number

T: IWithinRangeStringTag<L, H, T>

Parameters

l: L

h: H

Returns Tagged<T, string, string, unknown>