npm - @rapidrest/service-core - Versions diffs - 1.0.0-rc.7 → 1.0.0 - Mend

@rapidrest/service-core 1.0.0-rc.7 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (380) hide show

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Get.md DELETED Viewed

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-***
-[@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Get
-# Function: Get()
-> **Get**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
-Defined in: [src/decorators/RouteDecorators.ts:95](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L95)
-Indicates that the decorated function handles incoming `GET` requests at the given sub-path.
-## Parameters
-### path?
-`string`
-The sub-path that the route will handle requests for.
-## Returns
-(`target`, `propertyKey`, `descriptor`) => `void`

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Head.md DELETED Viewed

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-***
-[@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Head
-# Function: Head()
-> **Head**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
-Defined in: [src/decorators/RouteDecorators.ts:104](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L104)
-Indicates that the decorated function handles incoming `HEAD` requests at the given sub-path.
-## Parameters
-### path?
-`string`
-The sub-path that the route will handle requests for.
-## Returns
-(`target`, `propertyKey`, `descriptor`) => `void`

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Header.md DELETED Viewed

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-***
-[@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Header
-# Function: Header()
-> **Header**(`name`): (`target`, `propertyKey`, `index`) => `void`
-Defined in: [src/decorators/RouteDecorators.ts:113](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L113)
-Injects the value of the specified request header with the given name as the value of the decorated argument.
-## Parameters
-### name
-`string`
-The name of the header whose value will be injected.
-## Returns
-(`target`, `propertyKey`, `index`) => `void`

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Method.md DELETED Viewed

@@ -1,31 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-***
-[@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Method
-# Function: Method()
-> **Method**(`method`, `path?`): (`target`, `propertyKey`, `descriptor`) => `void`
-Defined in: [src/decorators/RouteDecorators.ts:127](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L127)
-Indicates that the decorated function handles incoming HTTP requests for the specified HTTP method(s) at the given sub-path.
-## Parameters
-### method
-`string` \| `string`[]
-The HTTP method(s) to handle requests for.
-### path?
-`string`
-The sub-path that the route handles requests for.
-## Returns
-(`target`, `propertyKey`, `descriptor`) => `void`

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Model.md DELETED Viewed

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-***
-[@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Model
-# Function: Model()
-> **Model**(`type`): \<`T`\>(`constructor`) => \{(...`args`): `(Anonymous class)`\<`T`\>; `modelClass`: `any`; `prototype`: `(Anonymous class)`\<`any`\>; \} & `T`
-Defined in: [src/decorators/RouteDecorators.ts:150](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L150)
-Indicates that the class utilizes is a manager for the specified class type.
-## Parameters
-### type
-`any`
-The data model class type to associate the class with.
-## Returns
-\<`T`\>(`constructor`) => \{(...`args`): `(Anonymous class)`\<`T`\>; `modelClass`: `any`; `prototype`: `(Anonymous class)`\<`any`\>; \} & `T`

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Options.md DELETED Viewed

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-***
-[@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Options
-# Function: Options()
-> **Options**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
-Defined in: [src/decorators/RouteDecorators.ts:164](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L164)
-Indicates that the decorated function handles incoming `OPTIONS` requests at the given sub-path.
-## Parameters
-### path?
-`string`
-The sub-path that the route will handle requests for.
-## Returns
-(`target`, `propertyKey`, `descriptor`) => `void`

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Param.md DELETED Viewed

@@ -1,26 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-***
-[@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Param
-# Function: Param()
-> **Param**(`name?`): (`target`, `propertyKey`, `index`) => `void`
-Defined in: [src/decorators/RouteDecorators.ts:174](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L174)
-Injects the value of the specified URI parameter with the given name as the value of the decorated argument. If no
-name is specified the entire request parameter will be injected.
-## Parameters
-### name?
-`string` \| `undefined`
-The name of the URI parameter whose value will be injected.
-## Returns
-(`target`, `propertyKey`, `index`) => `void`

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Patch.md DELETED Viewed

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-***
-[@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Patch
-# Function: Patch()
-> **Patch**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
-Defined in: [src/decorators/RouteDecorators.ts:187](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L187)
-Indicates that the decorated function handles incoming `PATCH` requests at the given sub-path.
-## Parameters
-### path?
-`string`
-The sub-path that the route will handle requests for.
-## Returns
-(`target`, `propertyKey`, `descriptor`) => `void`

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Post.md DELETED Viewed

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-***
-[@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Post
-# Function: Post()
-> **Post**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
-Defined in: [src/decorators/RouteDecorators.ts:196](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L196)
-Indicates that the decorated function handles incoming `POST` requests at the given sub-path.
-## Parameters
-### path?
-`string`
-The sub-path that the route will handle requests for.
-## Returns
-(`target`, `propertyKey`, `descriptor`) => `void`

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Protect.md DELETED Viewed

@@ -1,31 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-***
-[@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Protect
-# Function: Protect()
-> **Protect**(`acl?`): (`target`, `propertyKey?`) => `void`
-Defined in: [src/decorators/RouteDecorators.ts:222](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L222)
-Apply this to any route handler class or an individual route handler function to indicate that it should be
-protected by the AccessControlList security system. The `acl` parameter specifies the ACL governing access
-to the HTTP resource(s) defined. If a class and a given route handler function both have this decorator
-applied, the class ACL will be listed as the parent to the function's ACL object, thus inheriting
-whatever permissions applied to the class level.
-## Parameters
-### acl?
-`PartialACL` = `...`
-The access control list to define for this route class or handler. Not specifying a value here
-*          will default to the behavior of denying anonymous access to the resource and allowing any authenticated
-*         user CRUD access.
-## Returns
-(`target`, `propertyKey?`) => `void`

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Put.md DELETED Viewed

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-***
-[@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Put
-# Function: Put()
-> **Put**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
-Defined in: [src/decorators/RouteDecorators.ts:205](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L205)
-Indicates that the decorated function handles incoming `PUT` requests at the given sub-path.
-## Parameters
-### path?
-`string`
-The sub-path that the route will handle requests for.
-## Returns
-(`target`, `propertyKey`, `descriptor`) => `void`

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Query.md DELETED Viewed

@@ -1,26 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-***
-[@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Query
-# Function: Query()
-> **Query**(`name?`): (`target`, `propertyKey`, `index`) => `void`
-Defined in: [src/decorators/RouteDecorators.ts:265](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L265)
-Injects the value of the specified query parameter with the given name as the value of the decorated argument. If
-no name is specified the entire request query will be injected.
-## Parameters
-### name?
-`string` \| `undefined`
-THe name of the query parameter whose value will be injected.
-## Returns
-(`target`, `propertyKey`, `index`) => `void`

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Request.md DELETED Viewed

@@ -1,31 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-***
-[@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Request
-# Function: Request()
-> **Request**(`target`, `propertyKey`, `index`): `void`
-Defined in: [src/decorators/RouteDecorators.ts:276](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L276)
-Injects the Express request object as the value of the decorated argument.
-## Parameters
-### target
-`any`
-### propertyKey
-`string`
-### index
-`number`
-## Returns
-`void`

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/RequiresRole.md DELETED Viewed

@@ -1,26 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-***
-[@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / RequiresRole
-# Function: RequiresRole()
-> **RequiresRole**(`roles`): (`target`, `propertyKey`, `descriptor`) => `void`
-Defined in: [src/decorators/RouteDecorators.ts:297](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L297)
-Indicates that the client must be an authenticated user with at least one of the specified role(s) to process the
-request.
-## Parameters
-### roles
-`string` \| `string`[]
-The role(s) that an authenticated user must have to make the request.
-## Returns
-(`target`, `propertyKey`, `descriptor`) => `void`

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Response.md DELETED Viewed

@@ -1,31 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-***
-[@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Response
-# Function: Response()
-> **Response**(`target`, `propertyKey`, `index`): `void`
-Defined in: [src/decorators/RouteDecorators.ts:285](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L285)
-Injects the Express response object as the value of the decorated argument.
-## Parameters
-### target
-`any`
-### propertyKey
-`string`
-### index
-`number`
-## Returns
-`void`

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Route.md DELETED Viewed

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-***
-[@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Route
-# Function: Route()
-> **Route**(`paths`): (`target`) => `void`
-Defined in: [src/decorators/RouteDecorators.ts:310](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L310)
-Indicates that the decorated class contains Express route definitions.
-## Parameters
-### paths
-`string` \| `string`[]
-The base path(s) that all route definitions will use.
-## Returns
-(`target`) => `void`

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Socket.md DELETED Viewed

@@ -1,33 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-***
-[@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Socket
-# Function: Socket()
-> **Socket**(`target`, `propertyKey`, `index`): `void`
-Defined in: [src/decorators/RouteDecorators.ts:323](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L323)
-Injects the underlying Socket object associated with the request as the value of the decorated argument.
-When the handler function is for a WebSocket request, the returned socket will be the newly established
-WebSocket connection.
-## Parameters
-### target
-`any`
-### propertyKey
-`string`
-### index
-`number`
-## Returns
-`void`

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/User.md DELETED Viewed

@@ -1,31 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-***
-[@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / User
-# Function: User()
-> **User**(`target`, `propertyKey`, `index`): `void`
-Defined in: [src/decorators/RouteDecorators.ts:332](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L332)
-Injects the authenticated user object as the value of the decorated argument.
-## Parameters
-### target
-`any`
-### propertyKey
-`string`
-### index
-`number`
-## Returns
-`void`

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Validate.md DELETED Viewed

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-***
-[@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / Validate
-# Function: Validate()
-> **Validate**(`func`): (`target`, `propertyKey`, `descriptor`) => `void`
-Defined in: [src/decorators/RouteDecorators.ts:343](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L343)
-Indicates a validation function to execute in order to verify an incoming requests payload.
-## Parameters
-### func
-`string` \| `Function`
-The validation function to execute that will verify the request payload.
-## Returns
-(`target`, `propertyKey`, `descriptor`) => `void`

package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/WebSocket.md DELETED Viewed

@@ -1,25 +0,0 @@
-[**@rapidrest/service-core**](../../../../README.md)
-***
-[@rapidrest/service-core](../../../../globals.md) / [RouteDecorators](../README.md) / WebSocket
-# Function: WebSocket()
-> **WebSocket**(`path?`): (`target`, `propertyKey`, `descriptor`) => `void`
-Defined in: [src/decorators/RouteDecorators.ts:356](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/decorators/RouteDecorators.ts#L356)
-Indicates that the decorated function handles incoming `WebSocket` upgrade requests at the given sub-path.
-## Parameters
-### path?
-`string`
-The sub-path that the route will handle requests for.
-## Returns
-(`target`, `propertyKey`, `descriptor`) => `void`

package/docs/reference/README.md DELETED Viewed

@@ -1,20 +0,0 @@
-**@rapidrest/service-core**
-***
-# RapidREST: service-core
-[![pipeline status](https://gitlab.rapidrest.com/rapidrest/rapidrestjs/service-core/badges/master/pipeline.svg)](https://gitlab.rapidrest.com/rapidrest/rapidrestjs/service-core/-/commits/master)
-[![coverage report](https://gitlab.rapidrest.com/rapidrest/rapidrestjs/service-core/badges/master/coverage.svg)](https://gitlab.rapidrest.com/rapidrest/rapidrestjs/service-core/-/commits/master)
-Provides common functionality and utilities for RapidREST based REST API service projects.
-## NPM
-```
-npm i @rapidrest/service-core
-```
-## Yarn
-```
-yarn add @rapidrest/service-core
-```