Class Uri

Hierarchy

Uri

Implements

HashCode
Compare
Debug
Display

Index

Properties

authority fragment path query scheme

Methods

appendedPath appendedQuery appendedSegment appendedSlash base basePath compareTo copy debug display endpoint equals hashCode isDefined isEmpty likeType? parent parentPath prependedPath prependedQuery prependedSegment prependedSlash removedQuery resolve toLike toString unresolve updatedQuery withAuthority withAuthorityPart withFragment withFragmentIdentifier withFragmentPart withHost withHostIPv4 withHostIPv6 withHostName withHostPart withPassword withPath withPathName withPathPart withPort withPortNumber withPortPart withQuery withQueryPart withScheme withSchemeName withSchemePart withUser withUserPart withUsername authority authorityPart create empty form fragment fragmentIdentifier fragmentPart fromInit fromLike host hostIPv4 hostIPv6 hostName hostPart parse password path pathBuilder pathPart port portNumber portPart query queryBuilder queryPart scheme schemeName schemePart user userPart username

Properties

`Readonly` authority

authority: UriAuthority

`Readonly` fragment

fragment: UriFragment

`Readonly` path

`Readonly` query

query: UriQuery

`Readonly` scheme

scheme: UriScheme

Accessors

authorityPart

get authorityPart(): string
Returns string
- Defined in swim-uri/lib/main/Uri.d.ts:67

fragmentIdentifier

get fragmentIdentifier(): string
Returns string
- Defined in swim-uri/lib/main/Uri.d.ts:124

fragmentPart

get fragmentPart(): string
Returns string
- Defined in swim-uri/lib/main/Uri.d.ts:122

host

get host(): UriHost
Returns UriHost
- Defined in swim-uri/lib/main/Uri.d.ts:77

hostAddress

get hostAddress(): string
Returns string
- Defined in swim-uri/lib/main/Uri.d.ts:81

hostIPv4

get hostIPv4(): string
Returns string
- Defined in swim-uri/lib/main/Uri.d.ts:84

hostIPv6

get hostIPv6(): string
Returns string
- Defined in swim-uri/lib/main/Uri.d.ts:86

hostName

get hostName(): string
Returns string
- Defined in swim-uri/lib/main/Uri.d.ts:82

hostPart

get hostPart(): string
Returns string
- Defined in swim-uri/lib/main/Uri.d.ts:79

password

get password(): string
Returns string
- Defined in swim-uri/lib/main/Uri.d.ts:75

pathName

get pathName(): string
Returns string
- Defined in swim-uri/lib/main/Uri.d.ts:98

pathPart

get pathPart(): string
Returns string
- Defined in swim-uri/lib/main/Uri.d.ts:96

port

get port(): UriPort
Returns UriPort
- Defined in swim-uri/lib/main/Uri.d.ts:88

portNumber

get portNumber(): number
Returns number
- Defined in swim-uri/lib/main/Uri.d.ts:92

portPart

get portPart(): string
Returns string
- Defined in swim-uri/lib/main/Uri.d.ts:90

queryPart

get queryPart(): string
Returns string
- Defined in swim-uri/lib/main/Uri.d.ts:112

schemeName

get schemeName(): string
Returns string
- Defined in swim-uri/lib/main/Uri.d.ts:63

schemePart

get schemePart(): string
Returns string
- Defined in swim-uri/lib/main/Uri.d.ts:61

user

get user(): UriUser
Returns UriUser
- Defined in swim-uri/lib/main/Uri.d.ts:69

userPart

get userPart(): string
Returns string
- Defined in swim-uri/lib/main/Uri.d.ts:71

username

get username(): string
Returns string
- Defined in swim-uri/lib/main/Uri.d.ts:73

Methods

appendedPath

appendedPath(...components): Uri
Parameters
- Rest ...components: UriPathLike[]
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:104

appendedQuery

appendedQuery(key, value): Uri
Parameters
- key: string
- value: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:116
appendedQuery(params): Uri
Parameters
- params: UriQueryLike
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:117

appendedSegment

appendedSegment(segment): Uri
Parameters
- segment: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:106

appendedSlash

appendedSlash(): Uri
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:105

base

base(): Uri
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:103

basePath

basePath(): UriPath
Returns UriPath
- Defined in swim-uri/lib/main/Uri.d.ts:101

compareTo

compareTo(that): number
Parameters
- that: Uri
Returns number
Implementation of Compare.compareTo
- Defined in swim-uri/lib/main/Uri.d.ts:145

`Protected` copy

copy(scheme, authority, path, query, fragment): Uri
Parameters
- scheme: UriScheme
- authority: UriAuthority
- path: UriPath
- query: UriQuery
- fragment: UriFragment
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:131

debug

debug<T>(output): Output<T>
Type Parameters
- T
Parameters
- output: Output<T>
Returns Output<T>
Implementation of Debug.debug
- Defined in swim-uri/lib/main/Uri.d.ts:153

display

display<T>(output): Output<T>
Type Parameters
- T
Parameters
- output: Output<T>
Returns Output<T>
Implementation of Display.display
- Defined in swim-uri/lib/main/Uri.d.ts:157

endpoint

endpoint(): Uri
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:126

equals

equals(that): boolean
Parameters
- that: unknown
Returns boolean
Implementation of HashCode.equals
- Defined in swim-uri/lib/main/Uri.d.ts:147

hashCode

hashCode(): number
Returns number
Implementation of HashCode.hashCode
- Defined in swim-uri/lib/main/Uri.d.ts:151

isDefined

isDefined(): boolean
Returns boolean
- Defined in swim-uri/lib/main/Uri.d.ts:57

isEmpty

isEmpty(): boolean
Returns boolean
- Defined in swim-uri/lib/main/Uri.d.ts:58

`Optional` likeType

likeType(like): void
Parameters
- like: string | UriInit
Returns void
- Defined in swim-uri/lib/main/Uri.d.ts:56

parent

parent(): Uri
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:102

parentPath

parentPath(): UriPath
Returns UriPath
- Defined in swim-uri/lib/main/Uri.d.ts:100

prependedPath

prependedPath(...components): Uri
Parameters
- Rest ...components: UriPathLike[]
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:107

prependedQuery

prependedQuery(key, value): Uri
Parameters
- key: string
- value: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:118
prependedQuery(params): Uri
Parameters
- params: UriQueryLike
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:119

prependedSegment

prependedSegment(segment): Uri
Parameters
- segment: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:109

prependedSlash

prependedSlash(): Uri
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:108

removedQuery

removedQuery(key): Uri
Parameters
- key: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:115

resolve

resolve(relative): Uri
Parameters
- relative: UriLike
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:127

toLike

toLike(): {
    fragment?: string;
    host?: string;
    password?: string;
    path: string[];
    port?: number;
    query?: {
        [key: string]: string;
    };
    scheme?: string;
    username?: string;
}
Returns {
    fragment?: string;
    host?: string;
    password?: string;
    path: string[];
    port?: number;
    query?: {
        [key: string]: string;
    };
    scheme?: string;
    username?: string;
}
- Optional fragment?: string
- Optional host?: string
- Optional password?: string
- path: string[]
- Optional port?: number
- Optional query?: {
  [key: string]: string;
  }
  - [key: string]: string
- Optional scheme?: string
- Optional username?: string
- Defined in swim-uri/lib/main/Uri.d.ts:132

toString

toString(): string
Returns string
- Defined in swim-uri/lib/main/Uri.d.ts:159

unresolve

unresolve(absolute): Uri
Parameters
- absolute: UriLike
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:130

updatedQuery

updatedQuery(key, value): Uri
Parameters
- key: string
- value: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:114

withAuthority

withAuthority(authority): Uri
Parameters
- authority: UriAuthorityLike
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:66

withAuthorityPart

withAuthorityPart(authorityPart): Uri
Parameters
- authorityPart: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:68

withFragment

withFragment(fragment): Uri
Parameters
- fragment: UriFragmentLike
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:121

withFragmentIdentifier

withFragmentIdentifier(fragmentIdentifier): Uri
Parameters
- fragmentIdentifier: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:125

withFragmentPart

withFragmentPart(fragmentPart): Uri
Parameters
- fragmentPart: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:123

withHost

withHost(host): Uri
Parameters
- host: UriHostLike
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:78

withHostIPv4

withHostIPv4(hostIPv4): Uri
Parameters
- hostIPv4: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:85

withHostIPv6

withHostIPv6(hostIPv6): Uri
Parameters
- hostIPv6: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:87

withHostName

withHostName(hostName): Uri
Parameters
- hostName: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:83

withHostPart

withHostPart(hostPart): Uri
Parameters
- hostPart: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:80

withPassword

withPassword(password): Uri
Parameters
- password: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:76

withPath

withPath(...components): Uri
Parameters
- Rest ...components: UriPathLike[]
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:95

withPathName

withPathName(pathName): Uri
Parameters
- pathName: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:99

withPathPart

withPathPart(pathPart): Uri
Parameters
- pathPart: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:97

withPort

withPort(port): Uri
Parameters
- port: UriPortLike
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:89

withPortNumber

withPortNumber(portNumber): Uri
Parameters
- portNumber: number
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:93

withPortPart

withPortPart(portPart): Uri
Parameters
- portPart: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:91

withQuery

withQuery(query): Uri
Parameters
- query: UriQueryLike
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:111

withQueryPart

withQueryPart(query): Uri
Parameters
- query: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:113

withScheme

withScheme(scheme): Uri
Parameters
- scheme: UriSchemeLike
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:60

withSchemeName

withSchemeName(schemeName): Uri
Parameters
- schemeName: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:64

withSchemePart

withSchemePart(schemePart): Uri
Parameters
- schemePart: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:62

withUser

withUser(user): Uri
Parameters
- user: UriUserLike
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:70

withUserPart

withUserPart(userPart): Uri
Parameters
- userPart: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:72

withUsername

withUsername(username, password?): Uri
Parameters
- username: string
- Optional password: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:74

`Static` authority

authority(authority): Uri
Parameters
- authority: UriAuthorityLike
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:167

`Static` authorityPart

authorityPart(authorityPart): Uri
Parameters
- authorityPart: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:168

`Static` create

create(scheme?, authority?, path?, query?, fragment?): Uri
Parameters
- Optional scheme: UriScheme
- Optional authority: UriAuthority
- Optional path: UriPath
- Optional query: UriQuery
- Optional fragment: UriFragment
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:161

`Static` empty

empty(): Uri
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:160

`Static` form

form(): Form<Uri, UriLike>
Returns Form<Uri, UriLike>
- Defined in swim-uri/lib/main/Uri.d.ts:196

`Static` fragment

fragment(fragment): Uri
Parameters
- fragment: UriFragmentLike
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:185

`Static` fragmentIdentifier

fragmentIdentifier(fragmentIdentifier): Uri
Parameters
- fragmentIdentifier: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:187

`Static` fragmentPart

fragmentPart(fragmentPart): Uri
Parameters
- fragmentPart: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:186

`Static` fromInit

fromInit(init): Uri
Parameters
- init: UriInit
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:163

`Static` fromLike

fromLike<T>(value): Uri | Uninitable<T>
Type Parameters
- T extends UriLike
Parameters
- value: T
Returns Uri | Uninitable<T>
- Defined in swim-uri/lib/main/Uri.d.ts:162

`Static` host

host(host): Uri
Parameters
- host: UriHostLike
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:173

`Static` hostIPv4

hostIPv4(hostIPv4): Uri
Parameters
- hostIPv4: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:176

`Static` hostIPv6

hostIPv6(hostIPv6): Uri
Parameters
- hostIPv6: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:177

`Static` hostName

hostName(hostName): Uri
Parameters
- hostName: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:175

`Static` hostPart

hostPart(hostPart): Uri
Parameters
- hostPart: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:174

`Static` parse

parse(input): Parser<Uri>
Parameters
- input: Input
Returns Parser<Uri>
- Defined in swim-uri/lib/main/Uri.d.ts:192
parse(string): Uri
Parameters
- string: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:193

`Static` password

password(password): Uri
Parameters
- password: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:172

`Static` path

path(...components): Uri
Parameters
- Rest ...components: UriPathLike[]
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:181

`Static` pathBuilder

pathBuilder(): UriPathBuilder
Returns UriPathBuilder
- Defined in swim-uri/lib/main/Uri.d.ts:194

`Static` pathPart

pathPart(pathPart): Uri
Parameters
- pathPart: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:182

`Static` port

port(port): Uri
Parameters
- port: UriPortLike
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:178

`Static` portNumber

portNumber(portNumber): Uri
Parameters
- portNumber: number
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:180

`Static` portPart

portPart(portPart): Uri
Parameters
- portPart: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:179

`Static` query

query(query): Uri
Parameters
- query: UriQueryLike
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:183

`Static` queryBuilder

queryBuilder(): UriQueryBuilder
Returns UriQueryBuilder
- Defined in swim-uri/lib/main/Uri.d.ts:195

`Static` queryPart

queryPart(queryPart): Uri
Parameters
- queryPart: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:184

`Static` scheme

scheme(scheme): Uri
Parameters
- scheme: UriSchemeLike
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:164

`Static` schemeName

schemeName(name): Uri
Parameters
- name: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:166

`Static` schemePart

schemePart(schemePart): Uri
Parameters
- schemePart: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:165

`Static` user

user(user): Uri
Parameters
- user: UriUserLike
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:169

`Static` userPart

userPart(userPart): Uri
Parameters
- userPart: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:170

`Static` username

username(username, password?): Uri
Parameters
- username: string
- Optional password: string
Returns Uri
- Defined in swim-uri/lib/main/Uri.d.ts:171

Generated using TypeDoc