Skip to content

Commit

Permalink
🌟 implement it 💋
Browse files Browse the repository at this point in the history
  • Loading branch information
tunnckoCore committed Jun 5, 2015
1 parent ab0137e commit acc978c
Show file tree
Hide file tree
Showing 10 changed files with 444 additions and 2 deletions.
22 changes: 22 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# .editorconfig <https://github.com/tunnckoCore/dotfiles>
#
# Copyright (c) 2015 Charlike Mike Reagent, contributors.
# Released under the MIT license.
#

root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

[*.php]
indent_size = 4

[*.md]
insert_final_newline = false
trim_trailing_whitespace = false
56 changes: 56 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# .gitignore <https://github.com/tunnckoCore/dotfiles>
#
# Copyright (c) 2015 Charlike Mike Reagent, contributors.
# Released under the MIT license.
#

# Always-ignore dirs #
# ####################
_gh_pages
node_modules
bower_components
components
vendor
build
dest
dist
src
lib-cov
coverage
nbproject
cache
temp
tmp
always-callback

# Packages #
# ##########
*.7z
*.dmg
*.gz
*.iso
*.jar
*.rar
*.tar
*.zip

# OS, Logs and databases #
# #########################
*.pid
*.dat
*.log
*.sql
*.sqlite
*~
~*

# Another files #
# ###############
Icon?
.DS_Store*
Thumbs.db
ehthumbs.db
Desktop.ini
npm-debug.log
.directory
._*
27 changes: 27 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
language: "node_js"
sudo: false

node_js:
- "0.10"
- "0.12"
- "1.0"
- "1.8"
- "2.0"
- "2.1"

notifications:
email:
on_success: never
on_failure: never

before_script:
- npm install standard
- standard

script:
- npm install istanbul
- istanbul cover test.js

after_success:
- npm install coveralls
- cat ./coverage/lcov.info | coveralls
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@


## 0.0.0 - 2015-06-03
- first commits
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contributing Guidelines

Contributions are always welcome!

**Before spending lots of time on something, ask for feedback on your idea first!**

Please search issues and pull requests before adding something new to avoid duplicating efforts and conversations.


## Installing

Fork and clone the repo, then `npm install` to install all dependencies and `npm test` to ensure all is okey before you start anything.


## Testing

Tests are run with `npm test`. Please ensure all tests are passing before submitting a pull request (unless you're creating a failing test to increase test coverage or show a problem).

## Code Style

[![standard][standard-image]][standard-url]

This repository uses [`standard`][standard-url] to maintain code style and consistency, and to avoid style arguments. You are encouraged to install it globally. `npm test` runs `standard` so you don't have to!

```
npm i standard -g
```

It is intentional to don't have `standard`, `istanbul` and `coveralls` in the devDependencies. Travis will handle all that stuffs. That approach will save bandwidth also installing and development time.

[standard-image]: https://cdn.rawgit.com/feross/standard/master/badge.svg
[standard-url]: https://github.com/feross/standard
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# The MIT License

Copyright (c) 2015 [Charlike Make Reagent](http://j.mp/1stW47C)

> 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.
124 changes: 122 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,122 @@
# always-callback
Create callback api for given sync function. Guarantee that given function (sync or async, no matter) will always have callback api.
# always-callback [![npmjs.com][npmjs-img]][npmjs-url] [![The MIT License][license-img]][license-url]

> Create callback api for given sync function. Guarantee that given function (sync or async, no matter) will always have callback api and will handle errors correctly.
[![code climate][codeclimate-img]][codeclimate-url] [![standard code style][standard-img]][standard-url] [![travis build status][travis-img]][travis-url] [![coverage status][coveralls-img]][coveralls-url] [![dependency status][david-img]][david-url]


## Install
```
npm i always-callback --save
npm test
```


## Usage
> For more use-cases see the [tests](./test.js)
- `<fn>` **{Function}** function to transform
- `return` **{Function}** async function that must have callback

> It is useful for control-flow and hybrid APIs
**Example**

```js
var fs = require('fs')
var alwaysCallback = require('always-callback')

// if sync function given, transform it to async
var parse = alwaysCallback(JSON.parse)
parse('{"foo":"bar"}', function (err, res) {
console.log(err) //=> null
console.log(res) //=> { foo: 'bar' }
})

// if sync function given, transform it to async
var stringify = alwaysCallback(JSON.stringify)
stringify({foo: 'bar', baz: 'qux'}, null, 2, function (err, res) {
//=> it would prettify and stringify json
console.log(err) //=> null
console.log(res)
//=> {
// "foo": "bar",
// "baz": "qux"
// }
})

// if SYNC function given, transform it to async
var readFile = alwaysCallback(fs.readFileSync)
readFile('./package.json', 'utf8', function (err, res) {
console.log(err) //=> null
console.log(res) //=> { name: 'always-callback', ... }
})

// if ASYNC function given, it remains async
var statFile = alwaysCallback(fs.stat)
statFile('./package.json', function (err, res) {
console.log(err) //=> null
console.log(res)
//=> {
// dev: 64770,
// mode: 33204,
// nlink: 1,
// uid: 500, ... }
})
```


## Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/tunnckoCore/always-callback/issues/new).
But before doing anything, please read the [CONTRIBUTING.md](./CONTRIBUTING.md) guidelines.


## [Charlike Make Reagent](http://j.mp/1stW47C) [![new message to charlike][new-message-img]][new-message-url] [![freenode #charlike][freenode-img]][freenode-url]

[![tunnckocore.tk][author-www-img]][author-www-url] [![keybase tunnckocore][keybase-img]][keybase-url] [![tunnckoCore npm][author-npm-img]][author-npm-url] [![tunnckoCore twitter][author-twitter-img]][author-twitter-url] [![tunnckoCore github][author-github-img]][author-github-url]


[npmjs-url]: https://www.npmjs.com/package/always-callback
[npmjs-img]: https://img.shields.io/npm/v/always-callback.svg?label=always-callback

[license-url]: https://github.com/tunnckoCore/always-callback/blob/master/LICENSE.md
[license-img]: https://img.shields.io/badge/license-MIT-blue.svg


[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/always-callback
[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/always-callback.svg

[travis-url]: https://travis-ci.org/tunnckoCore/always-callback
[travis-img]: https://img.shields.io/travis/tunnckoCore/always-callback.svg

[coveralls-url]: https://coveralls.io/r/tunnckoCore/always-callback
[coveralls-img]: https://img.shields.io/coveralls/tunnckoCore/always-callback.svg

[david-url]: https://david-dm.org/tunnckoCore/always-callback
[david-img]: https://img.shields.io/david/tunnckoCore/always-callback.svg

[standard-url]: https://github.com/feross/standard
[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg


[author-www-url]: http://www.tunnckocore.tk
[author-www-img]: https://img.shields.io/badge/www-tunnckocore.tk-fe7d37.svg

[keybase-url]: https://keybase.io/tunnckocore
[keybase-img]: https://img.shields.io/badge/keybase-tunnckocore-8a7967.svg

[author-npm-url]: https://www.npmjs.com/~tunnckocore
[author-npm-img]: https://img.shields.io/badge/npm-~tunnckocore-cb3837.svg

[author-twitter-url]: https://twitter.com/tunnckoCore
[author-twitter-img]: https://img.shields.io/badge/twitter-@tunnckoCore-55acee.svg

[author-github-url]: https://github.com/tunnckoCore
[author-github-img]: https://img.shields.io/badge/github-@tunnckoCore-4183c4.svg

[freenode-url]: http://webchat.freenode.net/?channels=charlike
[freenode-img]: https://img.shields.io/badge/freenode-%23charlike-5654a4.svg

[new-message-url]: https://github.com/tunnckoCore/messages
[new-message-img]: https://img.shields.io/badge/send%20me-message-green.svg
19 changes: 19 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
/*!
* always-callback <https://github.com/tunnckoCore/always-callback>
*
* Copyright (c) 2015 Charlike Mike Reagent <@tunnckoCore> (http://www.tunnckocore.tk)
* Released under the MIT license.
*/

'use strict'

var isAsyncFn = require('is-async-function')
var makeCallback = require('make-callback')

module.exports = function alwaysCallback (fn) {
if (isAsyncFn(fn)) {
return fn
}

return makeCallback(fn)
}
20 changes: 20 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"name": "always-callback",
"version": "0.0.0",
"description": "Create callback api for given sync function. Guarantee that given function (sync or async, no matter) will always have callback api and will handle errors correctly.",
"repository": "tunnckoCore/always-callback",
"author": "Charlike Mike Reagent <@tunnckoCore> (http://www.tunnckocore.tk)",
"main": "index.js",
"license": "MIT",
"scripts": {
"test": "standard && node test.js"
},
"dependencies": {
"is-async-function": "^1.0.0",
"make-callback": "^1.0.0"
},
"devDependencies": {
"assertit": "^0.1.0"
},
"keywords": []
}

0 comments on commit acc978c

Please sign in to comment.