via-core

Description

Core interfaces, errors, helpers, etc.

Install

npm install
gulp build.node

API

Proxy

A proxy is an object responsible of interactions with the data source.

interface Proxy {
  format: string;
  build (schema: ViaSchema): Promise<any>;
  create (data: Object): Promise<Object>;
  read (filter: Object, options?: ReadOptions): Promise<Cursor>;
  readById (id: string, options?: ReadOptions): Promise<Object>;
  update (filter: Document, update: Object, options?: UpdateOptions): Promise<UpdateResult>;
  updateById (id: string, rev: string, update: Object, options?: UpdateOneOptions): Promise<UpdateResult>;
  delete (): Promise<any>;
}

.format: string

A string describing the data format returned by the database. Either json or bson.

.build (schema: ViaSchema): Promise<any>

Ensures that the required tables, collections, databases, and so on are created.

.create (data: Object): Promise<Object>

Creates a new entry in the database for the supplied plain object. Returns the data stored in the database, it may have additional fields (such as _id pr _rev).

.read (filter: Object, options?: ReadOptions): Promise<Cursor>

interface Cursor {
  toArray (): Promise<any[]>;
}
 
interface ReadOptions {
  fields?: Dictionary<boolean>;
  skip?: number;
  limit?: number;
  sort?: string[];
  timeout?: number;
}

The filter is a plain Mongo Query Document. You can choose the fields you want to select. (By default, the proxy will try to return all the fields). Given this document:

{
    foo: "foo string",
    quz: "quz string",
    child: {
        hello: "world!",
        bar: 42
    },
    atoms: [
        {
            name: "hydrogen",
            number: 1
        },
        {
            name: "carbon",
            number: 6
        }
    ]
}

And this projection:

{
    "foo": true,
    "child.bar": true,
    "atoms[].name": true
}

The result will contain at least:

{
    foo: "foo string",
    child: {
        bar: 42
    },
    atoms: [
        {
            name: "hydrogen"
        },
        {
            name: "carbon"
        }
    ]
}

.update (filter: Document, update: Object, options?: UpdateOptions): Promise<UpdateResult>

update is a diff object (obtained by the related Schema)

interface UpdateOptions {
  timeout?: number;
}
 
interface UpdateOneOptions {
  timeout?: number;
}
 
interface UpdateResult {
  updateCount: number;
}

Type<T, D>

Parameter	Description
T	Closest Typescript type
D	Diff type

read(format: string, val: any, options?: any): Bluebird.Thenable<T>

Attempt to read the value retrieved from the supplied format. Tries its best to return a valid value.

readTrusted(format: string, val: any, options?: any): Bluebird.Thenable<T>

Similar to read but allowed to emit extraneous tests when you have control over the encoded value.

write(format: string, val: T, options?: any): Bluebird.Thenable<any>

Prepare the value to be encoded in the supplied format.

test(val: any, options?: any): Bluebird.Thenable<Error>

Checks if the value matches the type. If the value is valid, test returns null, otherwise it returns an Error explaining why the value is not valid.

equals(val1: T, val2: T, options?: any): Bluebird.Thenable<boolean>

Returns a boolean indicating if both values are equal.

clone(val: T, options?: any): Bluebird.Thenable<T>

Returns a deep copy of val.

diff(oldVal: T, newVal: T, options?: any): Bluebird.Thenable<D>

Returns a diff representing the changes from oldVal to newVal.

patch(oldVal: T, diff: D, options?: any): Bluebird.Thenable<T>

Applyes the diff to oldVal in order to obtain newVal.

revert(newVal: T, diff: D, options?: any): Bluebird.Thenable<T>

The reverse of patch.

Schema

interface SchemaDiff {
  create: Dictionary<data>,
  update: Dictionary<diff>,
  delete: Dictionary<data>
}