DnsName.ts
DnsName overview
Table of contents
arbitrary
arbitrary
FastCheck arbitrary for generating random DnsName instances.
Signature
export declare const arbitrary: Arbitrary<string & Brand<"DnsName">>Added in v2.0.0
encoding
toBytes
Encode DnsName to bytes.
Signature
export declare const toBytes: (a: string & Brand<"DnsName">, overrideOptions?: ParseOptions) => anyAdded in v2.0.0
toHex
Encode DnsName to hex string.
Signature
export declare const toHex: (a: string & Brand<"DnsName">, overrideOptions?: ParseOptions) => stringAdded in v2.0.0
model
DnsName
Schema for DnsName with DNS-specific validation. dns_name = text .size (0 .. 128)
Signature
export declare const DnsName: Schema.brand<Schema.refine<string, typeof Schema.String>, "DnsName">Added in v2.0.0
DnsName (type alias)
Type alias for DnsName.
Signature
export type DnsName = typeof DnsName.TypeAdded in v2.0.0
parsing
fromBytes
Parse DnsName from bytes.
Signature
export declare const fromBytes: (i: any, overrideOptions?: ParseOptions) => string & Brand<"DnsName">Added in v2.0.0
fromHex
Parse DnsName from hex string.
Signature
export declare const fromHex: (i: string, overrideOptions?: ParseOptions) => string & Brand<"DnsName">Added in v2.0.0
predicates
isDnsName
Check if the given value is a valid DnsName
Signature
export declare const isDnsName: (u: unknown, overrideOptions?: ParseOptions | number) => u is string & Brand<"DnsName">Added in v2.0.0
utils
FromBytes
Signature
export declare const FromBytes: Schema.transform<
Schema.transform<
Schema.transform<typeof Schema.Uint8ArrayFromSelf, typeof Schema.String>,
Schema.refine<string, typeof Schema.String>
>,
Schema.brand<Schema.refine<string, typeof Schema.String>, "DnsName">
>FromHex
Signature
export declare const FromHex: Schema.transform<
Schema.transform<
Schema.Schema<Uint8Array, string, never>,
Schema.transform<
Schema.transform<typeof Schema.Uint8ArrayFromSelf, typeof Schema.String>,
Schema.refine<string, typeof Schema.String>
>
>,
Schema.brand<Schema.refine<string, typeof Schema.String>, "DnsName">
>