README
Uttori Storage Provider - JSON Memory
Uttori Storage Provider using JavaScript objects in memory. This does NOT persist or restore data.
This repo exports both a Uttori Plugin compliant Plugin
class as well as the underlying StorageProvider
class.
Install
npm install --save @uttori/storage-provider-json-memory
Config
{
update_timestamps: true,
use_history: true,
// Registration Events
events: {
add: ['storage-add'],
delete: ['storage-delete'],
get: ['storage-get'],
getHistory: ['storage-get-history'],
getRevision: ['storage-get-revision'],
getQuery: ['storage-query'],
update: ['storage-update'],
validateConfig: ['validate-config'],
},
}
Example
// When part of UttoriWiki:
import { Plugin as StorageProviderJSON } from '@uttori/storage-provider-json-memory';
// or
const { Plugin: StorageProviderJSON } = require('@uttori/storage-provider-json-memory');
// When stand alone:
import StorageProvider from '@uttori/storage-provider-json-memory';
// or
const { StorageProvider } = require('@uttori/storage-provider-json-memory');
const s = new StorageProvider();
s.add({
title: 'Example Title',
slug: 'example-title',
content: '## Example Title',
html: '',
updateDate: 1459310452001,
createDate: 1459310452001,
tags: ['Example Tag'],
customData: {
keyA: 'value-a',
keyB: 'value-b',
keyC: 'value-c',
},
});
const results = s.getQuery('SELECT tags FROM documents WHERE slug IS_NOT_NULL ORDER BY slug ASC LIMIT 1');
➜ results === [
{ tags: ['Example Tag'] },
]
const results = s.getQuery('SELECT COUNT(*) FROM documents WHERE slug IS_NOT_NULL ORDER BY RANDOM ASC LIMIT -1');
➜ results === 1
API Reference
Classes
- StorageProvider
Storage for Uttori documents using JSON objects in memory.
Functions
- debug() :
function
Typedefs
StorageProvider
Storage for Uttori documents using JSON objects in memory.
Kind: global class
Properties
Name | Type | Description |
---|---|---|
documents | Array.<UttoriDocument> |
The collection of documents. |
history | object |
The collection of document histories indexes. |
histories | object |
The collection of document revisions by index. |
new StorageProvider([config])
Creates an instance of StorageProvider.
Param | Type | Default | Description |
---|---|---|---|
[config] | object |
A configuration object. | |
[config.update_timestamps] | boolean |
true |
Should update times be marked at the time of edit. |
[config.use_history] | boolean |
true |
Should history entries be created. |
Example (Init StorageProvider)
const storageProvider = new StorageProvider();
object
storageProvider.all() ⇒ Returns all documents.
Kind: instance method of StorageProvider
Returns: object
- All documents.
Example
storageProvider.all();
➜ { 'first-document': { slug: 'first-document', ... }, ... }
Array
storageProvider.getQuery(query) ⇒ Returns all documents matching a given query.
Kind: instance method of StorageProvider
Returns: Array
- The items matching the supplied query.
Param | Type | Description |
---|---|---|
query | string |
The conditions on which documents should be returned. |
UttoriDocument
storageProvider.get(slug) ⇒ Returns a document for a given slug.
Kind: instance method of StorageProvider
Returns: UttoriDocument
- The returned UttoriDocument.
Param | Type | Description |
---|---|---|
slug | string |
The slug of the document to be returned. |
Array.<string>
storageProvider.getHistory(slug) ⇒ Returns the history of edits for a given slug.
Kind: instance method of StorageProvider
Returns: Array.<string>
- The returned history object.
Param | Type | Description |
---|---|---|
slug | string |
The slug of the document to get history for. |
UttoriDocument
storageProvider.getRevision(params) ⇒ Returns a specifc revision from the history of edits for a given slug and revision timestamp.
Kind: instance method of StorageProvider
Returns: UttoriDocument
- The returned revision of the document.
Param | Type | Description |
---|---|---|
params | object |
The params object. |
params.slug | string |
The slug of the document to be returned. |
params.revision | string | number |
The unix timestamp of the history to be returned. |
storageProvider.add(document)
Saves a document to internal array.
Kind: instance method of StorageProvider
Param | Type | Description |
---|---|---|
document | UttoriDocument |
The document to be added to the collection. |
storageProvider.updateValid(params) ℗
Updates a document and saves to memory.
Kind: instance method of StorageProvider
Access: private
Param | Type | Description |
---|---|---|
params | object |
The params object. |
params.document | UttoriDocument |
The document to be updated in the collection. |
params.originalSlug | string |
The original slug identifying the document, or the slug if it has not changed. |
storageProvider.update(params)
Updates a document and figures out how to save to memory. Calling with a new document will add that document.
Kind: instance method of StorageProvider
Param | Type | Description |
---|---|---|
params | object |
The params object. |
params.document | UttoriDocument |
The document to be updated in the collection. |
params.originalSlug | string |
The original slug identifying the document, or the slug if it has not changed. |
storageProvider.delete(slug)
Removes a document from memory.
Kind: instance method of StorageProvider
Param | Type | Description |
---|---|---|
slug | string |
The slug identifying the document. |
storageProvider.reset()
Resets to the initial state.
Kind: instance method of StorageProvider
storageProvider.updateHistory(params)
Updates History for a given slug, renaming the key and history key as needed.
Kind: instance method of StorageProvider
Param | Type | Description |
---|---|---|
params | object |
The params object. |
params.slug | string |
The slug of the document to update history for. |
params.content | UttoriDocument |
The revision of the document to be saved. |
[params.originalSlug] | string |
The original slug identifying the document, or the slug if it has not changed. |
function
debug() :
UttoriDocument
Kind: global typedef
Properties
Name | Type | Description |
---|---|---|
slug | string |
The unique identifier for the document. |
[createDate] | number | Date |
The creation date of the document. |
[updateDate] | number | Date |
The last date the document was updated. |
Tests
To run the test suite, first install the dependencies, then run npm test
:
npm install
npm test
DEBUG=Uttori* npm test
Misc.
You can see the various speeds of the array shuffles used for RANDOM sorting on perf.link