yodata-actions v0.1.1

Yodata Actions

Generators for http://schema.org/Actions with a consistent and uniform JSON format.

Getting Started

Installing

npm i --save @yodata/actions

Usage

import {Action, TypedObject} from @yodata/actions

let bob =  TypedObject('Person','Bob')
let alice =  TypedObject('Person','Alice')
let book  = TypedObject('Book','The Little Prince')

// Bob gives the book to Alice
let action = Action('GiveAction').the(book).from(bob).to(alice)

console.log(action)
// =>
    {
        context: 'http://schema.org/',
        type: 'GiveAction',
        object: { context: 'http://schema.org/', type: 'Book' },
        sender: { context: 'http://schema.org/', type: 'Person' },
        recipient: { context: 'http://schema.org/', type: 'Person' }
    }

End with an example of getting some data out of the system or using it for a little demo

Running the tests

$ jest

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Dave Duran (dave@yodata.io) - Initial work - Yodata

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• builds on the incredibly awesome work at schema.org