vyze
v0.1.20
Published
Client for VYZE
Downloads
189
Maintainers
Readme
VYZE client for JavaScript
Database client for VYZE written in TypeScript.
Quickstart
Install the vyze
npm package:
npm install vyze
Example
import {SystemClient, ServiceClient, ResourceSchema} from "vyze";
const systemClient = new SystemClient();
const serviceClient = new ServiceClient();
const universeId = await serviceClient.resolveUniverse('my_universe')!;
const universe = serviceClient.loadUniverse(universeId);
const objectSchema = new ResourceSchema()
// Add 'id' field and encode object IDs as hex:
.field('id', 'id', 'hex')
// Add 'name' field containing the name of the object:
.field('name', 'name', 'string')
// Add 'created' field containing the UNIX timestemp of the object:
.field('created', 'created', 'integer');
const objects = systemClient.getResource(
universe.resolve('base.object/'),
'specials',
objectSchema,
);
console.log(objects);
License
Copyright 2022 Bitspark GmbH
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.