Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UriAuthority

Hierarchy

  • UriAuthority

Implements

Index

Constructors

constructor

Properties

Readonly hashValue

hashValue: undefined | number

Readonly host

host: UriHost

Readonly port

port: UriPort

Readonly stringValue

stringValue: undefined | string

Readonly user

user: UriUser

Accessors

hostAddress

  • get hostAddress(): string
  • Returns string

hostIPv4

  • get hostIPv4(): undefined | string
  • Returns undefined | string

hostIPv6

  • get hostIPv6(): undefined | string
  • Returns undefined | string

hostName

  • get hostName(): undefined | string
  • Returns undefined | string

hostPart

  • get hostPart(): string
  • Returns string

password

  • get password(): undefined | string
  • Returns undefined | string

portNumber

  • get portNumber(): number
  • Returns number

portPart

  • get portPart(): string
  • Returns string

userPart

  • get userPart(): string
  • Returns string

username

  • get username(): undefined | string
  • Returns undefined | string

Methods

compareTo

  • compareTo(that: unknown): number
  • Parameters

    • that: unknown

    Returns number

Protected copy

debug

  • debug(output: Output<unknown>): void
  • Parameters

    Returns void

display

  • display(output: Output<unknown>): void
  • Parameters

    Returns void

equals

  • equals(that: unknown): boolean
  • Parameters

    • that: unknown

    Returns boolean

hashCode

  • hashCode(): number
  • Returns number

isDefined

  • isDefined(): boolean
  • Returns boolean

toAny

  • toAny(authority?: { host?: string; password?: string; port?: number; username?: string }): undefined | { host?: string; password?: string; port?: number; username?: string }
  • Parameters

    • Optional authority: { host?: string; password?: string; port?: number; username?: string }
      • Optional host?: string
      • Optional password?: string
      • Optional port?: number
      • Optional username?: string

    Returns undefined | { host?: string; password?: string; port?: number; username?: string }

toString

  • toString(): string
  • Returns string

withHost

  • Parameters

    Returns UriAuthority

withHostIPv4

  • Parameters

    • hostIPv4: string

    Returns UriAuthority

withHostIPv6

  • Parameters

    • hostIPv5: string

    Returns UriAuthority

withHostName

  • Parameters

    • hostName: string

    Returns UriAuthority

withHostPart

  • Parameters

    • hostPart: string

    Returns UriAuthority

withPassword

  • Parameters

    • password: undefined | string

    Returns UriAuthority

withPort

  • Parameters

    Returns UriAuthority

withPortNumber

  • Parameters

    • portNumber: number

    Returns UriAuthority

withPortPart

  • Parameters

    • portPart: string

    Returns UriAuthority

withUser

  • Parameters

    Returns UriAuthority

withUserPart

  • Parameters

    • userPart: string

    Returns UriAuthority

withUsername

  • withUsername(username: undefined | string, password?: string): UriAuthority
  • Parameters

    • username: undefined | string
    • Optional password: string

    Returns UriAuthority

Static create

  • Parameters

    Returns UriAuthority

Static fromAny

  • Parameters

    Returns UriAuthority

Static fromInit

Static host

  • Parameters

    Returns UriAuthority

Static hostIPv4

  • Parameters

    • hostIPv4: string

    Returns UriAuthority

Static hostIPv6

  • Parameters

    • hostIPv6: string

    Returns UriAuthority

Static hostName

  • Parameters

    • hostName: string

    Returns UriAuthority

Static hostPart

  • Parameters

    • hostPart: string

    Returns UriAuthority

Static parse

  • Parameters

    • authorityPart: string

    Returns UriAuthority

Static password

  • Parameters

    • password: string

    Returns UriAuthority

Static port

  • Parameters

    Returns UriAuthority

Static portNumber

  • Parameters

    • portNumber: number

    Returns UriAuthority

Static portPart

  • Parameters

    • portPart: string

    Returns UriAuthority

Static undefined

  • Returns UriAuthority

Static user

  • Parameters

    Returns UriAuthority

Static userPart

  • Parameters

    • userPart: string

    Returns UriAuthority

Static username

  • username(username: string, password?: string): UriAuthority
  • Parameters

    • username: string
    • Optional password: string

    Returns UriAuthority

Generated using TypeDoc