Module fetcher

The various fetchers mimic the native fetch method, adding increasingly opinionated layers on top of it.

RewritingFetcher is the most basic, simply allowing (asynchronous) manipulation of a fetch request before it is sent.
JsonFetcher adds automatic serialization and deserialization, using the JsonConverter to convert into given TypeScript types.
RestFetcher provides GET/PUT/POST/DELETE semantics for the object type handled by the underlying JsonFetcher.

Index

Classes

Interfaces

Type aliases

RequestRewriter

Functions

Type aliases

RequestRewriter

RequestRewriter: (request: SimpleRequest) => SimpleRequest | Promise<SimpleRequest> | Observable<SimpleRequest>

Type declaration

- (request: SimpleRequest): SimpleRequest | Promise<SimpleRequest> | Observable<SimpleRequest>
- A rewriter is a function which takes a RequestData and returns a (possibly) modified version of it. This would typically be adding necessary Authentication headers, but in principle it can rewrite anything. (A RequestRewriter can also reject a request by throwing an Aborted exception).
  
  Parameters
  - request: SimpleRequest
  Returns SimpleRequest | Promise<SimpleRequest> | Observable<SimpleRequest>

Functions

Const ABORT

ABORT(request: SimpleRequest): SimpleRequest | Promise<SimpleRequest> | Observable<SimpleRequest>

A default implementation of a RequestRewriter which always throws an Aborted error. (E.g. if the user has not logged in yet, and all attempts to contact a server endpoint should be denied).

Parameters
- request: SimpleRequest
Returns SimpleRequest | Promise<SimpleRequest> | Observable<SimpleRequest>

Const ANONYMOUS

ANONYMOUS(request: SimpleRequest): SimpleRequest | Promise<SimpleRequest> | Observable<SimpleRequest>

A default implementation of a RequestRewriter which doesn't manipulate the request at all.

Parameters
- request: SimpleRequest
Returns SimpleRequest | Promise<SimpleRequest> | Observable<SimpleRequest>

appendQuery

appendQuery(url: string, query: string): string
appendQuery(url: string, query: undefined | null | string): string | undefined

Parameters
- url: string
- query: string
Returns string
Parameters
- url: string
- query: undefined | null | string
Returns string | undefined

ensureLeadingQuestionmark

ensureLeadingQuestionmark(query: string): string
ensureLeadingQuestionmark(query: undefined | null | string): string | undefined

Parameters
- query: string
Returns string
Parameters
- query: undefined | null | string
Returns string | undefined

ensureTrailingSlash

ensureTrailingSlash(url: string): string
ensureTrailingSlash(url: undefined | null | string): string | undefined

Parameters
- url: string
Returns string
Parameters
- url: undefined | null | string
Returns string | undefined

noTrailingSlash

noTrailingSlash(url: string): string
noTrailingSlash(url: undefined | null | string): string | undefined

Parameters
- url: string
Returns string
Parameters
- url: undefined | null | string
Returns string | undefined

setHeader

setHeader(request: SimpleRequest, name: string, value: string): SimpleRequest

Parameters
- request: SimpleRequest
- name: string
- value: string
Returns SimpleRequest

setHeaders

setHeaders(request: SimpleRequest, headers: Record<string, string>): SimpleRequest

Parameters
- request: SimpleRequest
- headers: Record<string, string>
Returns SimpleRequest

toQueryString

toQueryString(query: undefined | null | string | {}): string

Parameters
- query: undefined | null | string | {}
Returns string