1. Miscellaneous
2. Functions

Index

Body   (projects/.../body.decorator.ts) chainHandlers   (projects/.../request-builder.ts) Client   (projects/.../client.decorator.ts) ErrorHandler   (projects/.../error-handler.decorator.ts) Guards   (projects/.../guards.decorator.ts) Handlers   (projects/.../handlers.decorator.ts) Header   (projects/.../header.decorator.ts) Headers   (projects/.../headers.decorator.ts) InjectToken   (projects/.../inject-token.decorator.ts) OnClientReady   (projects/.../on-client-ready.decorator.ts) Path   (projects/.../path.decorator.ts) Query   (projects/.../query.decorator.ts) requestBuilder   (projects/.../request-builder.ts) requestFactory   (projects/.../request-builder.ts) requestFactory   (projects/.../request-builder.ts) requestFactory   (projects/.../request-builder.ts) startGuardCheck   (projects/.../request-builder.ts) WithCredentials   (projects/.../with-credentials.decorator.ts)

projects/rest/src/lib/body.decorator.ts

Body

Body()

Returns : ParameterDecorator

projects/rest/src/lib/request-builder.ts

chainHandlers

chainHandlers(handlers, context, source)

Parameters : Name Optional handlers No context No source No Returns : Promise<T>

requestBuilder

requestBuilder(type)

Parameters : Name Optional type No Returns : RestPropertyDecorator

requestFactory

requestFactory(method, url, config)

Parameters : Name Optional method No url No config No Returns : HttpRequest<T>

requestFactory

requestFactory(method, url, config)

Parameters : Name Optional method No url No config No Returns : HttpRequest<T>

requestFactory

requestFactory(method, url, undefined)

Parameters : Name Optional method No url No No Returns : HttpRequest<T>

startGuardCheck

startGuardCheck(target, methodName, request, context)

Parameters : Name Optional target No methodName No request No context No Returns : Promise<boolean>

projects/rest/src/lib/client.decorator.ts

Client

Client(undefined)

Parameters : Name Optional No

projects/rest/src/lib/error-handler.decorator.ts

ErrorHandler

ErrorHandler()

projects/rest/src/lib/guards.decorator.ts

Guards

Guards(guardFunctions)

Parameters : Name Optional guardFunctions No Returns : PropertyDescriptor

projects/rest/src/lib/handlers.decorator.ts

Handlers

Handlers(handlers)

Parameters : Name Optional handlers No Returns : PropertyDescriptor

projects/rest/src/lib/header.decorator.ts

Header

Header(name, replace)

Parameters : Name Optional name No replace No Returns : ParameterDecorator

projects/rest/src/lib/headers.decorator.ts

Headers

Headers(headers)

Parameters : Name Optional headers No Returns : PropertyDescriptor

projects/rest/src/lib/inject-token.decorator.ts

InjectToken

InjectToken(token)

Parameters : Name Optional token No Returns : PropertyDecorator

projects/rest/src/lib/on-client-ready.decorator.ts

OnClientReady

OnClientReady()

Returns : PropertyDescriptor

projects/rest/src/lib/path.decorator.ts

Path

Path(key)

A parameter decorated with Path will replace the specified key in the url Parameters : Name Optional Description key No Path placeholder key Returns : ParameterDecorator

projects/rest/src/lib/query.decorator.ts

Query

Query(key)

Use this decorator to set a query parameter Parameters : Name Optional Description key No Request query name Returns : ParameterDecorator

projects/rest/src/lib/with-credentials.decorator.ts

WithCredentials

WithCredentials(withCredentials)

Parameters : Name Optional withCredentials No Returns : PropertyDescriptor