Skip to main content Link Search Menu Expand Document (external link)

UrlParams overview

Added in v1.0.0


Table of contents


combinators

append

Signature

export declare const append: {
  (key: string, value: string): (self: UrlParams) => UrlParams
  (self: UrlParams, key: string, value: string): UrlParams
}

Added in v1.0.0

appendAll

Signature

export declare const appendAll: {
  (input: Input): (self: UrlParams) => UrlParams
  (self: UrlParams, input: Input): UrlParams
}

Added in v1.0.0

getAll

Signature

export declare const getAll: {
  (key: string): (self: UrlParams) => ReadonlyArray<string>
  (self: UrlParams, key: string): ReadonlyArray<string>
}

Added in v1.0.0

getFirst

Signature

export declare const getFirst: {
  (key: string): (self: UrlParams) => Option.Option<string>
  (self: UrlParams, key: string): Option.Option<string>
}

Added in v1.0.0

getLast

Signature

export declare const getLast: {
  (key: string): (self: UrlParams) => Option.Option<string>
  (self: UrlParams, key: string): Option.Option<string>
}

Added in v1.0.0

remove

Signature

export declare const remove: {
  (key: string): (self: UrlParams) => UrlParams
  (self: UrlParams, key: string): UrlParams
}

Added in v1.0.0

set

Signature

export declare const set: {
  (key: string, value: string): (self: UrlParams) => UrlParams
  (self: UrlParams, key: string, value: string): UrlParams
}

Added in v1.0.0

setAll

Signature

export declare const setAll: {
  (input: Input): (self: UrlParams) => UrlParams
  (self: UrlParams, input: Input): UrlParams
}

Added in v1.0.0

toString

Signature

export declare const toString: (self: UrlParams) => string

Added in v1.0.0

constructors

empty

Signature

export declare const empty: UrlParams

Added in v1.0.0

fromInput

Signature

export declare const fromInput: (input: Input) => UrlParams

Added in v1.0.0

makeUrl

Signature

export declare const makeUrl: <E>(url: string, params: UrlParams, onError: (e: unknown) => E) => Effect.Effect<URL, E>

Added in v1.0.0

models

Input (type alias)

Signature

export type Input = Readonly<Record<string, string>> | Iterable<readonly [string, string]> | URLSearchParams

Added in v1.0.0

UrlParams (interface)

Signature

export interface UrlParams extends ReadonlyArray<readonly [string, string]> {}

Added in v1.0.0

schema

schemaJson

Signature

export declare const schemaJson: <A, I, R>(
  schema: Schema.Schema<A, I, R>,
  options?: ParseOptions | undefined
) => {
  (field: string): (self: UrlParams) => Effect.Effect<A, ParseResult.ParseError, R>
  (self: UrlParams, field: string): Effect.Effect<A, ParseResult.ParseError, R>
}

Added in v1.0.0

schemas

schema

Signature

export declare const schema: Schema.Schema<UrlParams, ReadonlyArray<readonly [string, string]>>

Added in v1.0.0