@rapidrest/service-core 1.0.0-beta.1

package/docs/reference/classes/ObjectFactory.md

@@ -0,0 +1,336 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / ObjectFactory
+
+# Class: ObjectFactory
+
+Defined in: [src/ObjectFactory.ts:21](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ObjectFactory.ts#L21)
+
+The `ObjectFactory` is a manager for creating objects based on registered
+class types. This allows for the tracking of multiple instances of objects
+so that references can be referenced by unique name.
+
+## Author
+
+Jean-Philippe Steinmetz
+
+## Extends
+
+- `ObjectFactory`
+
+## Constructors
+
+### Constructor
+
+> **new ObjectFactory**(`config?`, `logger?`): `ObjectFactory`
+
+Defined in: [src/ObjectFactory.ts:22](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ObjectFactory.ts#L22)
+
+#### Parameters
+
+##### config?
+
+`any`
+
+##### logger?
+
+`any`
+
+#### Returns
+
+`ObjectFactory`
+
+#### Overrides
+
+`CoreObjectFactory.constructor`
+
+## Properties
+
+### classes
+
+> `readonly` **classes**: `Map`\<`string`, `any`\>
+
+Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:22
+
+A map for string fully qualified class names to their class types.
+
+#### Inherited from
+
+`CoreObjectFactory.classes`
+
+***
+
+### config
+
+> `protected` **config**: `any`
+
+Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:24
+
+The global application configuration object.
+
+#### Inherited from
+
+`CoreObjectFactory.config`
+
+***
+
+### instances
+
+> `readonly` **instances**: `Map`\<`string`, `any`\>
+
+Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:26
+
+A map for the unique name to the intance of a particular class type.
+
+#### Inherited from
+
+`CoreObjectFactory.instances`
+
+***
+
+### logger
+
+> `protected` **logger**: `any`
+
+Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:28
+
+The application logging utility.
+
+#### Inherited from
+
+`CoreObjectFactory.logger`
+
+## Methods
+
+### clear()
+
+> **clear**(): `void`
+
+Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:37
+
+Deletes all instantiated objects.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`CoreObjectFactory.clear`
+
+***
+
+### clearAll()
+
+> **clearAll**(): `void`
+
+Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:41
+
+Deletes all instantiated objects and registered class types.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`CoreObjectFactory.clearAll`
+
+***
+
+### destroy()
+
+> **destroy**(`objs?`): `Promise`\<`void`\>
+
+Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:33
+
+Destroys the specified objects. If `undefined` is passed in, all objects managed by the factory are destroyed.
+
+#### Parameters
+
+##### objs?
+
+`any`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+`CoreObjectFactory.destroy`
+
+***
+
+### getInitMethods()
+
+> **getInitMethods**(`obj`): `Function`[]
+
+Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:53
+
+Searches an object for one or more functions that implement a `@Init` decorator.
+
+#### Parameters
+
+##### obj
+
+`any`
+
+The object to search.
+
+#### Returns
+
+`Function`[]
+
+The list of functions that implements the `@Init` decorator if found, otherwise undefined.
+
+#### Inherited from
+
+`CoreObjectFactory.getInitMethods`
+
+***
+
+### getInstance()
+
+> **getInstance**\<`T`\>(`nameOrType`): `T` \| `undefined`
+
+Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:61
+
+Returns the object instance with the given unique name. Unique names take the form `<ClassName>:<InstanceName>`.
+It is possible to only specifiy the `<ClassName>`, doing so will automatically look for the `<ClassName>:default`
+instance or the first found instance of the given type.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### nameOrType
+
+`any`
+
+The unique name or class type of the object to retrieve.
+
+#### Returns
+
+`T` \| `undefined`
+
+The object instance associated with the given name if found, otherwise `undefined`.
+
+#### Inherited from
+
+`CoreObjectFactory.getInstance`
+
+***
+
+### initialize()
+
+> **initialize**\<`T`\>(`obj`): `Promise`\<`T`\>
+
+Defined in: [src/ObjectFactory.ts:30](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ObjectFactory.ts#L30)
+
+Scans the given object for any properties with the
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### obj
+
+`any`
+
+The object to initialize with injected defaults
+
+#### Returns
+
+`Promise`\<`T`\>
+
+#### Inject
+
+decorator and assigns the correct values.
+
+#### Overrides
+
+`CoreObjectFactory.initialize`
+
+***
+
+### newInstance()
+
+> **newInstance**\<`T`\>(`type`, `options?`): `T` \| `Promise`\<`T`\>
+
+Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:71
+
+Creates a new instance of the class specified with the provided unique name or type and constructor arguments. If an existing
+object has already been created with the given name, that instance is returned, otherwise a new instance is created
+using the provided arguments.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### type
+
+`any`
+
+The fully qualified name or type of the class to instantiate. If a type is given it's class name will be inferred
+via the constructor name.
+
+##### options?
+
+`InstanceOptions`
+
+The options to use when instantiating the new class object.
+
+#### Returns
+
+`T` \| `Promise`\<`T`\>
+
+#### Inherited from
+
+`CoreObjectFactory.newInstance`
+
+***
+
+### register()
+
+> **register**(`clazz`, `fqn?`): `void`
+
+Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:77
+
+Registers the given class type for the provided fully qualified name.
+
+#### Parameters
+
+##### clazz
+
+`any`
+
+The class type to register.
+
+##### fqn?
+
+`string`
+
+The fully qualified name of the class to register. If not specified, the class name will be used.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`CoreObjectFactory.register`

package/docs/reference/classes/OpenAPIRoute.md

@@ -0,0 +1,77 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / OpenAPIRoute
+
+# Class: OpenAPIRoute
+
+Defined in: [src/routes/OpenAPIRoute.ts:44](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/OpenAPIRoute.ts#L44)
+
+The `OpenAPIRoute` provides default routes to expose the service's OpenAPI specification.
+
+- `GET /` — Swagger UI HTML (loads swagger-ui-dist from CDN)
+- `GET /openapi.json` — raw OpenAPI specification as JSON
+- `GET /openapi.yaml` — raw OpenAPI specification as YAML
+
+## Author
+
+Jean-Philippe Steinmetz
+
+## Constructors
+
+### Constructor
+
+> **new OpenAPIRoute**(): `OpenAPIRoute`
+
+#### Returns
+
+`OpenAPIRoute`
+
+## Methods
+
+### getAPIDocs()
+
+> **getAPIDocs**(): `string`
+
+Defined in: [src/routes/OpenAPIRoute.ts:63](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/OpenAPIRoute.ts#L63)
+
+#### Returns
+
+`string`
+
+***
+
+### getHTML()
+
+> **getHTML**(): `string`
+
+Defined in: [src/routes/OpenAPIRoute.ts:54](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/OpenAPIRoute.ts#L54)
+
+#### Returns
+
+`string`
+
+***
+
+### getJSON()
+
+> **getJSON**(): `any`
+
+Defined in: [src/routes/OpenAPIRoute.ts:71](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/OpenAPIRoute.ts#L71)
+
+#### Returns
+
+`any`
+
+***
+
+### getYAML()
+
+> **getYAML**(): `string`
+
+Defined in: [src/routes/OpenAPIRoute.ts:80](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/OpenAPIRoute.ts#L80)
+
+#### Returns
+
+`string`