Endpoint

Source

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

Endpoint<ReturnT = any>

Examples

Simple usage with useAsync

Passing query parameters with useAsync

Integrating pagination

API

Constructor

new Endpoint(urlPattern,?options)

Source

Arguments:

	Argument	Type
*	urlPattern	string\|UrlPattern
	options An object with the properties below
	options.baseUrl	string
	options.body	null\|BodyInit
	options.cache	RequestCache
	options.credentials	RequestCredentials
	options.decodeBody
	options.getMiddleware
	options.headers	HeadersInit\|Record
	options.integrity	string
	options.keepalive	boolean
	options.method	string
	options.middleware	(\|)[]
	options.mode	RequestMode
	options.paginator	\|null
	options.redirect	RequestRedirect
	options.referrer	string
	options.referrerPolicy	ReferrerPolicy
	options.resolveUrl
	options.signal	null\|AbortSignal
	options.window	null

Methods

decodeBody(res)

Source

Arguments:

	Argument	Type	Description
*	res	Response

Returns:any

execute(?options)

Source

Arguments:

Argument	Type	Description
options An object with the properties below
options.body	null\|BodyInit
options.cache	RequestCache
options.credentials	RequestCredentials
options.headers	HeadersInit\|Record
options.integrity	string
options.keepalive	boolean
options.method	string
options.mode	RequestMode
options.paginator	\|null
options.redirect	RequestRedirect
options.referrer	string
options.referrerPolicy	ReferrerPolicy
options.signal	null\|AbortSignal
options.window	null
...	any	Any properties from UrlResolveOptions

Returns:Promise

fetch(url,?requestInit)

Source

Arguments:

	Argument	Type	Description
*	url	string
	requestInit	RequestInit

Returns:Promise

getPaginatorClass<T>()

Source

Returns:null|

prepare(?options)

Source

Arguments:

Argument	Type	Description
options An object with the properties below
options.body	null\|BodyInit
options.cache	RequestCache
options.credentials	RequestCredentials
options.headers	HeadersInit\|Record
options.integrity	string
options.keepalive	boolean
options.method	string
options.mode	RequestMode
options.paginator	\|null
options.redirect	RequestRedirect
options.referrer	string
options.referrerPolicy	ReferrerPolicy
options.signal	null\|AbortSignal
options.window	null
...	any	Any properties from UrlResolveOptions

Returns:

An object with these properties:
	Property	Type	Description
*	endpoint	Endpoint
*	execute		Deprecated:
*	options
*	urlResolveOptions	UrlResolveOptions

resolveUrl(urlPattern,urlArgs,query,baseUrl)

Source

Arguments:

	Argument	Type
*	urlPattern	UrlPattern
*	urlArgs	Record
*	query	undefined\|QueryStringParams
*	baseUrl	string

Returns:string

Properties

baseUrl

Source

string

middleware

Source

(|)[]

requestInit

Source


Property	Type	Description
body	null\|BodyInit
cache	RequestCache
credentials	RequestCredentials
headers	HeadersInit\|Record
integrity	string
keepalive	boolean
method	string
mode	RequestMode
paginator	\|null
redirect	RequestRedirect
referrer	string
referrerPolicy	ReferrerPolicy
signal	null\|AbortSignal
window	null

urlPattern

Source

UrlPattern

Static Properties

defaultConfig

Source

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

On this page

Examples

Simple usage with useAsync

Passing query parameters with useAsync

Integrating pagination

API

Constructor

Arguments:

Methods

Arguments:

Arguments:

Arguments:

Arguments:

Arguments:

Properties

baseUrl

middleware

requestInit

urlPattern

Static Properties

defaultConfig