Endpoint

import { Endpoint } from "@prestojs/rest";

Endpoint<ReturnT = any>

API

Show inherited

Constructor

new Endpoint(urlPattern,?options)

Arguments:

	Argument	Type	Description
*	urlPattern	UrlPattern
	options An object with the properties below
	options.baseUrl	string
	options.decodeBody
	options.getMiddleware
	options.middleware	(\|)[]
	options.resolveUrl
	...	any	Any properties from ExecuteInitOptions

Methods

decodeBody(res)

Component Props:

	Prop	Type	Description
*	res	Response

execute(?options)

Arguments:

Argument	Type	Description
options An object with the properties below
...	any	Any properties from ExecuteInitOptions
...	any	Any properties from UrlResolveOptions

Returns:Promise

fetch(url,requestInit)

Arguments:

	Argument	Type	Description
*	url	string
*	requestInit	undefined\|RequestInit

Returns:Promise

prepare(?options)

Arguments:

Argument	Type	Description
options An object with the properties below
...	any	Any properties from ExecuteInitOptions
...	any	Any properties from UrlResolveOptions

Returns:PreparedAction

resolveUrl(urlPattern)

Component Props:

	Prop	Type	Description
*	urlPattern	UrlPattern

Properties

baseUrl

Source

string

middleware

Source

(|)[]

requestInit

Source

ExecuteInitOptions

urlPattern

Source

UrlPattern

Static Properties

defaultConfig

Source

An object with these properties:
	Property	Type	Description
*	baseUrl	string
*	getMiddleware
*	middleware	(\|)[]
*	requestInit	RequestInit

On this page

API

Constructor

Arguments:

Methods

Component Props:

Arguments:

Arguments:

Arguments:

Component Props:

Properties

baseUrl

middleware

requestInit

urlPattern

Static Properties

defaultConfig