Class RouteUrlBuilder

Fluent builder for named-route URLs

Index

Constructors

Methods

size pixelRatio colors tint text overlay grid param build

Constructors

constructor

new RouteUrlBuilder(route: string): RouteUrlBuilder
Parameters
- route: string
Returns RouteUrlBuilder
- Defined in utils/url-builder.ts:428

Methods

size

size(width: number, height?: number): this
Parameters
- width: number
- Optionalheight: number
Returns this
- Defined in utils/url-builder.ts:429

pixelRatio

pixelRatio(ratio: number): this
Parameters
- ratio: number
Returns this
- Defined in utils/url-builder.ts:430

colors

colors(opts: { fg?: string; bg?: string; color?: string }): this
Parameters
- opts: { fg?: string; bg?: string; color?: string }
Returns this
- Defined in utils/url-builder.ts:431

tint

tint(color: string): this
Parameters
- color: string
Returns this
- Defined in utils/url-builder.ts:432

text

text(content: string, opts?: Partial<OverlayTextParams>): this
Parameters
- content: string
- Optionalopts: Partial<OverlayTextParams>
Returns this
- Defined in utils/url-builder.ts:433

overlay

overlay(iconId: string, opts?: Partial<OverlaySvgParams>): this
Parameters
- iconId: string
- Optionalopts: Partial<OverlaySvgParams>
Returns this
- Defined in utils/url-builder.ts:434

grid

grid(iconIds: string[], opts?: Partial<OverlayGridParams>): this
Parameters
- iconIds: string[]
- Optionalopts: Partial<OverlayGridParams>
Returns this
- Defined in utils/url-builder.ts:435

param

param<
    K extends
        | "width"
        | "height"
        | "pixelRatio"
        | (keyof SvgColorParams)
        | (keyof SpriteTintParams)
        | (keyof OverlayTextParams)
        | (keyof OverlaySvgParams)
        | (keyof OverlayGridParams),
>(
    key: K,
    value: RouteUrlParams[K],
): this
Type Parameters
- K extends
      | "width"
      | "height"
      | "pixelRatio"
      | (keyof SvgColorParams)
      | (keyof SpriteTintParams)
      | (keyof OverlayTextParams)
      | (keyof OverlaySvgParams)
      | (keyof OverlayGridParams)
Parameters
- key: K
- value: RouteUrlParams[K]
Returns this
- Defined in utils/url-builder.ts:436

build

build(): string
Returns string
- Defined in utils/url-builder.ts:437