Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Uri

Hierarchy

  • Uri

Implements

Index

Properties

Accessors

Methods

Properties

Readonly authority

authority: UriAuthority

Readonly fragment

fragment: UriFragment

Readonly path

path: UriPath

Readonly query

query: UriQuery

Readonly scheme

scheme: UriScheme

Accessors

authorityPart

  • get authorityPart(): string

fragmentIdentifier

  • get fragmentIdentifier(): undefined | string

fragmentPart

  • get fragmentPart(): string

host

hostAddress

  • get hostAddress(): string

hostIPv4

  • get hostIPv4(): undefined | string

hostIPv6

  • get hostIPv6(): undefined | string

hostName

  • get hostName(): undefined | string

hostPart

  • get hostPart(): string

password

  • get password(): undefined | string

pathName

  • get pathName(): string

pathPart

  • get pathPart(): string

port

portNumber

  • get portNumber(): number

portPart

  • get portPart(): string

queryPart

  • get queryPart(): string

schemeName

  • get schemeName(): string

schemePart

  • get schemePart(): string

user

userPart

  • get userPart(): string

username

  • get username(): undefined | string

Static standardParser

Methods

appendedPath

appendedQuery

  • appendedQuery(key: undefined | string, value: string): Uri
  • appendedQuery(params: AnyUriQuery): Uri

appendedSegment

  • appendedSegment(segment: string): Uri

appendedSlash

  • appendedSlash(): Uri

base

basePath

compareTo

  • compareTo(that: Uri): number

Protected copy

debug

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

display

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

endpoint

  • endpoint(): Uri

equals

  • equals(that: unknown): boolean

hashCode

  • hashCode(): number

isDefined

  • isDefined(): boolean

isEmpty

  • isEmpty(): boolean

parent

  • parent(): Uri

parentPath

prependedPath

prependedQuery

  • prependedQuery(key: undefined | string, value: string): Uri
  • prependedQuery(params: AnyUriQuery): Uri

prependedSegment

  • prependedSegment(segment: string): Uri

prependedSlash

  • prependedSlash(): Uri

removedQuery

  • removedQuery(key: string): Uri

resolve

toAny

  • toAny(): { fragment?: string; host?: string; password?: string; path: string[]; port?: number; query?: {}; scheme?: string; username?: string }

  • Returns { fragment?: string; host?: string; password?: string; path: string[]; port?: number; query?: {}; scheme?: string; username?: string }

    • Optional fragment?: string
    • Optional host?: string
    • Optional password?: string
    • path: string[]
    • Optional port?: number
    • Optional query?: {}
      • [key: string]: string
    • Optional scheme?: string
    • Optional username?: string

toString

  • toString(): string

unresolve

updatedQuery

  • updatedQuery(key: string, value: string): Uri

withAuthority

withAuthorityPart

  • withAuthorityPart(authorityPart: string): Uri

withFragment

withFragmentIdentifier

  • withFragmentIdentifier(fragmentIdentifier: undefined | string): Uri

withFragmentPart

  • withFragmentPart(fragmentPart: string): Uri

withHost

withHostIPv4

  • withHostIPv4(hostIPv4: string): Uri

withHostIPv6

  • withHostIPv6(hostIPv6: string): Uri

withHostName

  • withHostName(hostName: string): Uri

withHostPart

  • withHostPart(hostPart: string): Uri

withPassword

  • withPassword(password: undefined | string): Uri

withPath

withPathName

  • withPathName(pathName: string): Uri

withPathPart

  • withPathPart(pathPart: string): Uri

withPort

withPortNumber

  • withPortNumber(portNumber: number): Uri

withPortPart

  • withPortPart(portPart: string): Uri

withQuery

withQueryPart

  • withQueryPart(query: string): Uri

withScheme

withSchemeName

  • withSchemeName(schemeName: string): Uri

withSchemePart

  • withSchemePart(schemePart: string): Uri

withUser

withUserPart

  • withUserPart(userPart: string): Uri

withUsername

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

Static authority

Static authorityPart

  • authorityPart(authorityPart: string): Uri

Static create

Static empty

Static form

Static fragment

Static fragmentIdentifier

  • fragmentIdentifier(fragmentIdentifier: undefined | string): Uri

Static fragmentPart

  • fragmentPart(fragmentPart: string): Uri

Static fromAny

  • fromAny(value: undefined | null | AnyUri): Uri

Static fromInit

Static host

Static hostIPv4

  • hostIPv4(hostIPv4: string): Uri

Static hostIPv6

  • hostIPv6(hostIPv6: string): Uri

Static hostName

  • hostName(hostName: string): Uri

Static hostPart

  • hostPart(hostPart: string): Uri

Static parse

  • parse(string: string): Uri

Static password

  • password(password: string): Uri

Static path

Static pathBuilder

Static pathPart

  • pathPart(pathPart: string): Uri

Static port

Static portNumber

  • portNumber(portNumber: number): Uri

Static portPart

  • portPart(portPart: string): Uri

Static query

Static queryBuilder

Static queryPart

  • queryPart(queryPart: string): Uri

Static scheme

Static schemeName

  • schemeName(name: string): Uri

Static schemePart

  • schemePart(schemePart: string): Uri

Static user

Static userPart

  • userPart(userPart: string): Uri

Static username

  • username(username: string, password?: string): Uri

Generated using TypeDoc