Class UrlBuilder

Base class for immutable URL grammars.

Implements

DashboardUrl

Index

Constructors

Methods

toString toURL url

Constructors

constructor

new UrlBuilder(url: URL): UrlBuilder
Creates an immutable URL builder at the supplied URL.
Parameters
- url: URL
Returns UrlBuilder
Example
```
const builder = new UrlBuilder(
  new URL('/applications/my-app', 'https://dashboard.sanity.io'),
)

builder.url() // '/applications/my-app'
```
- Defined in packages/react/src/dashboard/urlFor.ts:154

Methods

toString

toString(): string
Returns the same relative URL as UrlBuilder.url.

Returns string
Example
```
const builder = new UrlBuilder(
  new URL('/applications/my-app', 'https://dashboard.sanity.io'),
)

`${builder}` // '/applications/my-app'
```
Implementation of DashboardUrl.toString
- Defined in packages/react/src/dashboard/urlFor.ts:289

toURL

toURL(__namedParameters: { origin: string }): URL
Returns the URL as a platform URL object using the supplied origin.
Parameters
- __namedParameters: { origin: string }
Returns URL
Example
```
const builder = new UrlBuilder(
  new URL('/applications/my-app', 'https://dashboard.sanity.io'),
)

builder.toURL({origin: 'https://dashboard.sanity.io'}).pathname
// '/applications/my-app'
```
Implementation of DashboardUrl.toURL
- Defined in packages/react/src/dashboard/urlFor.ts:273

url

url(options?: { origin?: string }): string
Returns the URL as a relative string by default.

Supplying an origin returns an absolute URL string for the same dashboard route.
Parameters
- Optionaloptions: { origin?: string }
Returns string
Example
```
const builder = new UrlBuilder(
  new URL('/applications/my-app', 'https://dashboard.sanity.io'),
)

builder.url() // '/applications/my-app'
builder.url({origin: 'https://dashboard.sanity.io'})
// 'https://dashboard.sanity.io/applications/my-app'
```
Implementation of DashboardUrl.url
- Defined in packages/react/src/dashboard/urlFor.ts:255