gengojs-notation

1.0.1 • Public • Published

notation

The official notation used in gengo.js

Build Status

Documentation

See documentation

Usage

import Notation from 'gengojs-notation';
var text = 'Hello world!';
 
var phrase = new Notation(text).parse();
// -> { type: 'phrase', key: 'Hello world!, seek: undefined }
 
text = '[Hello world!]';
 
var bracket = new Notation(text).parse();
// -> { type: 'bracket', key: 'Hello world!, seek: undefined }
 
text = '[Hello world!].informal';
 
bracket = new Notation(text).parse();
// -> { type: 'bracket', key: 'Hello world!, seek: 'informal' }
 
text = 'hello.world';
 
var dot = new Notation(text).parse();
 
// -> { type: 'dot', key: 'hello.world', seek: undefined' }
 

Contribution

Simply fork the project and create a pull request to enhance this project!

Dependents (1)

Package Sidebar

Install

npm i gengojs-notation

Weekly Downloads

2

Version

1.0.1

License

MIT

Last publish

Collaborators

  • iwatakeshi