Merge pull request #170 from HarperDB/export-resources

Document server.resources

Author: kriszyp

docs/technical-details/reference/globals.md

@@ -262,4 +262,24 @@ This records the provided value as a metric into Harper's analytics. Harper effi
 This returns the user object with permissions/authorization information based on the provided username. This does not verify the password, so it is generally used for looking up users by username. If you want to verify a user by password, use [`server.authenticateUser`](globals.md#serverauthenticateuserusername-password-user).
 
 ### `server.authenticateUser(username, password): Promise<User>`
-This returns the user object with permissions/authorization information based on the provided username. The password will be verified before returning the user object (if the password is incorrect, an error will be thrown).
+This returns the user object with permissions/authorization information based on the provided username. The password will be verified before returning the user object (if the password is incorrect, an error will be thrown).
+
+### `server.resources: Resources`
+This provides access to the map of all registered resources. This is the central registry in Harper for registering any resources to be exported for use by REST, MQTT, or other components. Components that want to register resources should use the `server.resources.set(name, resource)` method to add to this map. Exported resources can be found by passing in a path to `server.resources.getMatch(path)` which will find any resource that matches the path or beginning of the path.
+
+#### `server.resources.set(name, resource, exportTypes?)`
+Register a resource with the server. For example:
+```
+class NewResource extends Resource {
+}
+server.resources.set('NewResource', Resource);
+// or limit usage:
+server.resources.set('NewResource', Resource, { rest: true, mqtt: false, 'my-protocol': true });
+```
+#### `server.resources.getMatch(path, exportType?)`
+Find a resource that matches the path. For example:
+```
+server.resources.getMatch('/NewResource/some-id');
+// or specify the export/protocol type, to allow it to be limited:
+server.resources.getMatch('/NewResource/some-id', 'my-protocol');
+```