@rapidrest/core 1.3.1 → 1.3.2

package/docs/reference/classes/ObjectFactory.md

@@ -1,276 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / ObjectFactory
-
-# Class: ObjectFactory
-
-Defined in: [src/ObjectFactory.ts:36](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L36)
-
-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
-
-## Constructors
-
-### Constructor
-
-> **new ObjectFactory**(`config?`, `logger?`): `ObjectFactory`
-
-Defined in: [src/ObjectFactory.ts:55](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L55)
-
-#### Parameters
-
-##### config?
-
-`any`
-
-##### logger?
-
-`any`
-
-#### Returns
-
-`ObjectFactory`
-
-## Properties
-
-### classes
-
-> `readonly` **classes**: `Map`\<`string`, `any`\>
-
-Defined in: [src/ObjectFactory.ts:38](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L38)
-
-A map for string fully qualified class names to their class types.
-
-***
-
-### config
-
-> `protected` **config**: `any`
-
-Defined in: [src/ObjectFactory.ts:41](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L41)
-
-The global application configuration object.
-
-***
-
-### instances
-
-> `readonly` **instances**: `Map`\<`string`, `any`\>
-
-Defined in: [src/ObjectFactory.ts:44](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L44)
-
-A map for the unique name to the intance of a particular class type.
-
-***
-
-### logger
-
-> `protected` **logger**: `any`
-
-Defined in: [src/ObjectFactory.ts:47](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L47)
-
-The application logging utility.
-
-## Methods
-
-### clear()
-
-> **clear**(): `void`
-
-Defined in: [src/ObjectFactory.ts:158](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L158)
-
-Deletes all instantiated objects.
-
-#### Returns
-
-`void`
-
-***
-
-### clearAll()
-
-> **clearAll**(): `void`
-
-Defined in: [src/ObjectFactory.ts:166](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L166)
-
-Deletes all instantiated objects and registered class types.
-
-#### Returns
-
-`void`
-
-***
-
-### destroy()
-
-> **destroy**(`objs?`): `Promise`\<`void`\>
-
-Defined in: [src/ObjectFactory.ts:117](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L117)
-
-Destroys the specified objects. If `undefined` is passed in, all objects managed by the factory are destroyed.
-
-#### Parameters
-
-##### objs?
-
-`any`
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### getInitMethods()
-
-> **getInitMethods**(`obj`): `Function`[]
-
-Defined in: [src/ObjectFactory.ts:248](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L248)
-
-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.
-
-***
-
-### getInstance()
-
-> **getInstance**\<`T`\>(`nameOrType`): `T` \| `undefined`
-
-Defined in: [src/ObjectFactory.ts:282](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L282)
-
-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`.
-
-***
-
-### initialize()
-
-> **initialize**\<`T`\>(`obj`): `T` \| `Promise`\<`T`\>
-
-Defined in: [src/ObjectFactory.ts:175](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L175)
-
-Scans the given object for any properties with the `@Inject` decorator and assigns the correct values.
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### obj
-
-`any`
-
-The object to initialize with injected defaults
-
-#### Returns
-
-`T` \| `Promise`\<`T`\>
-
-***
-
-### newInstance()
-
-> **newInstance**\<`T`\>(`type`, `options?`): `T` \| `Promise`\<`T`\>
-
-Defined in: [src/ObjectFactory.ts:323](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L323)
-
-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`](../interfaces/InstanceOptions.md)
-
-The options to use when instantiating the new class object.
-
-#### Returns
-
-`T` \| `Promise`\<`T`\>
-
-***
-
-### register()
-
-> **register**(`clazz`, `fqn?`): `void`
-
-Defined in: [src/ObjectFactory.ts:399](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectFactory.ts#L399)
-
-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`

package/docs/reference/classes/ObjectUtils.md

@@ -1,60 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / ObjectUtils
-
-# Class: ObjectUtils
-
-Defined in: [src/ObjectUtils.ts:12](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectUtils.ts#L12)
-
-Utility class for working with objects.
-
-## Author
-
-Jean-Philippe Steinmetz
-
-## Constructors
-
-### Constructor
-
-> **new ObjectUtils**(): `ObjectUtils`
-
-#### Returns
-
-`ObjectUtils`
-
-## Methods
-
-### validate()
-
-> `static` **validate**(`obj`, `clazz?`, `recurse?`): `void`
-
-Defined in: [src/ObjectUtils.ts:21](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/ObjectUtils.ts#L21)
-
-Performs validation of the given object or array. Validation is performed by scanning the object class for properties
-decorated with `@Validator` and executing the provided validation function.
-
-#### Parameters
-
-##### obj
-
-`any`
-
-The object or array of objects to validate.
-
-##### clazz?
-
-`any`
-
-The class type that contains the validation metadata.
-
-##### recurse?
-
-`boolean`
-
-Set to `true` to validate all child objects.
-
-#### Returns
-
-`void`

package/docs/reference/classes/StringUtils.md

@@ -1,169 +0,0 @@
-[**@rapidrest/core**](../README.md)
-
-***
-
-[@rapidrest/core](../globals.md) / StringUtils
-
-# Class: StringUtils
-
-Defined in: [src/StringUtils.ts:10](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/StringUtils.ts#L10)
-
-Utility functions for working with strings.
-
-## Author
-
-Jean-Philippe Steinmetz
-
-## Constructors
-
-### Constructor
-
-> **new StringUtils**(): `StringUtils`
-
-#### Returns
-
-`StringUtils`
-
-## Methods
-
-### findAndReplace()
-
-> `static` **findAndReplace**(`contents`, `variables`): `string`
-
-Defined in: [src/StringUtils.ts:46](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/StringUtils.ts#L46)
-
-Performs a search and replace on the provided contents with the map of variable replacements. The contents
-must use Mustache formatted tokens such as `{{toreplace}}`.
-
-#### Parameters
-
-##### contents
-
-`string`
-
-The stringt to perform the find and replace on.
-
-##### variables
-
-`any`
-
-A map of key=>value pairs to search for and replace.
-
-#### Returns
-
-`string`
-
-***
-
-### getParameters()
-
-> `static` **getParameters**(`str`): `string`[]
-
-Defined in: [src/StringUtils.ts:18](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/StringUtils.ts#L18)
-
-Returns a list of all parameters contained within the string. A parameter is a bracket delimited substring
-(e.g. /my/{key}/with/{id}).
-
-#### Parameters
-
-##### str
-
-`string`
-
-The string to search for parameters.
-
-#### Returns
-
-`string`[]
-
-A list of parameters contained in the provided string.
-
-***
-
-### replaceAll()
-
-> `static` **replaceAll**(`str`, `match`, `prefix`): `string`
-
-Defined in: [src/StringUtils.ts:87](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/StringUtils.ts#L87)
-
-Replaces all instances of the match regex pattern with the contents of the inner regular expression pattern for
-the given string.
-
-e.g.
-
-let result = replaceAll('/my/path/{id}', new RegExp('\{([^\}]+)\}'), ':');
-console.log(result); // -> /my/path/:id
-
-#### Parameters
-
-##### str
-
-`string`
-
-The string to perform replacement on.
-
-##### match
-
-`string` \| `RegExp`
-
-The regular expression pattern to match containing an outer and inner pattern.
-
-##### prefix
-
-`string`
-
-The prefix to prepend the replacement text with.
-
-#### Returns
-
-`string`
-
-The fully replaced contents of the string.
-
-***
-
-### toCamelCase()
-
-> `static` **toCamelCase**(`str`): `string`
-
-Defined in: [src/StringUtils.ts:104](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/StringUtils.ts#L104)
-
-Converts the first character in the given string to be lowercase (e.g. myVariable).
-
-#### Parameters
-
-##### str
-
-`string`
-
-The string to convert to camelCase.
-
-#### Returns
-
-`string`
-
-The string converted to camelCase.
-
-***
-
-### toPascalCase()
-
-> `static` **toPascalCase**(`str`): `string`
-
-Defined in: [src/StringUtils.ts:114](https://github.com/rapidrest/core/blob/a4c031c9927a28230ae2f4bc0d881f4d5a54cdeb/src/StringUtils.ts#L114)
-
-Converts the first character in the given string to be uppercase (e.g. MyVariable).
-
-#### Parameters
-
-##### str
-
-`string`
-
-The string to convert to PascalCase.
-
-#### Returns
-
-`string`
-
-The string converted to PascalCase.