https://github.com/jingxinxin/memobird-node

unofficial memobird node sdk
https://github.com/jingxinxin/memobird-node

guguji memobird node

Last synced: about 2 months ago
JSON representation

unofficial memobird node sdk

• Host: GitHub
• URL: https://github.com/jingxinxin/memobird-node
• Owner: jingxinxin
• License: mit
• Created: 2017-03-03T15:10:45.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-03-07T07:28:36.000Z (almost 8 years ago)
• Last Synced: 2024-10-16T09:12:14.599Z (2 months ago)
• Topics: guguji, memobird, node
• Language: JavaScript
• Size: 401 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# memobird-node

 unofficial memobird node sdk

[![Build Status](http://img.shields.io/travis/jingxinxin/memobird-node.svg)](https://travis-ci.org/jingxinxin/memobird-node)

[![Npm Status](https://img.shields.io/npm/v/memobird-node.svg)](https://www.npmjs.com/package/memobird-node)

## Install

`$ npm i memobird-node`  or `$ yarn add memobird-node`

> If you need print picture, you should install [GraphicsMagick](http://www.graphicsmagick.org/)

>

> `$ brew install graphicsmagick`

## Usage

### Tiny Example

```javascript

import Memobird from 'memobird-node';

const guguji = new Memobird({

  memobirdID: 'xxxxxxxxxxxx',

  ak: 'xxxxxxxxxxxxxxxxxxxxxxxxxx',

});

guguji.setup()

  .then(guguji => guguji.print('hello, world!'))

  .catch(guguji.catchErr);

```

### Print Array && Image

```javascript

import Memobird from 'memobird-node';

import {param} from './example';// you must set the params first

const guguji = new Memobird(param);

const printArr = [

  { type: 'text',  value: 'Hello, Jack' },

  { type: 'pic',   value: 'images/test.png' },

  { type: 'pic_url', value: 'http://abc.xyz/images/xxx.png' },

];

guguji.setup()

  .then(() => guguji.print('Hello, World!'))

  .then(() => guguji.print(printArr))

  .then(() => console.log('all print task have done!'))

  .catch(gu.catchErr);

```

## Example

`$ npm run start` or `babel-node example.js --presets es2015`

## Test

`$ npm run test`  or `eslint lib/index.js && mocha test/lib/index.js --require babel-core/register`

## TODO

* CLI version

* More feature

## License

MIT License

Copyright (c) 2017 Jack·S[www.51201314.me]

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.