@godeners/things

Things

What is this?

Things is a RESTful-like domain protocol based on Microvision Chain and MetaID DID protocol. Developers can use Things to create his own domain resource.

How to use?

The API examples listed here are still under development.

Define domain

import { define, use } from '@godeners/things'

// define api returns a class represents what the domain is.
const Buzz = define('buzz', {
  //...
})

// use api returns a class represents what the domain is. (using existing domain)
const Buzz = use('buzz')

Use domain

// list
const buzzes = Buzz.list()

// list filtered by query
const buzzes = Buzz.list({
  where: {
    title: 'Hello World',
  },
})

// my list
Buzz.login('0x1234567890') // metaid or address
const myBuzzes = Buzz.myList()

// has container
Buzz.login('0x1234567890') // metaid or address
const hasRoot: boolean = Buzz.hasContainer()

// create container
Buzz.login('0x1234567890') // metaid or address
await Buzz.createContainer()

// get one
const buzz = Buzz.one('0x1234567890') // txid
const buzz = Buzz.first('0x1234567890') // or use alias `first`
const buzz = Buzz.get('0x1234567890') // ...or `get`
const buzz = Buzz.one({
  where: {
    title: 'Hello World',
  },
})

// create
const newBuzz = Buzz.create({
  title: 'Hello World',
  content: 'This is my first buzz',
})

// update
const updatedBuzz = Buzz.update('0x1234567890', {
  title: 'Hello World',
  content: 'This is my first buzz',
})
// or update one existing resource
const oldBuzz = Buzz.get('0x1234567890')
const updatedBuzz = oldBuzz.update({
  title: 'Hello World',
  content: 'This is my first buzz',
})

// delete
const deletedBuzz = Buzz.delete('0x1234567890')
// or delete one existing resource
oldBuzz.delete()