https://github.com/wbinnssmith/promise-method

Wraps a function and returns one that always returns a promise
https://github.com/wbinnssmith/promise-method

Last synced: about 2 months ago
JSON representation

Wraps a function and returns one that always returns a promise

• Host: GitHub
• URL: https://github.com/wbinnssmith/promise-method
• Owner: wbinnssmith
• License: mit
• Created: 2015-09-19T06:42:35.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-12-15T20:18:51.000Z (7 months ago)
• Last Synced: 2024-04-03T19:45:04.050Z (3 months ago)
• Language: JavaScript
• Size: 3.91 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-promises - promise-method - Standalone `bluebird.method`. Turn a synchronously-returning method into a promise-returning one. (Convenience Utilities / Others)

README

        
# promise-method

[![Build Status](https://travis-ci.org/wbinnssmith/promise-method.svg)](https://travis-ci.org/wbinnssmith/promise-method)

[![js-semistandard-style](https://cdn.rawgit.com/flet/semistandard/master/badge.svg)](https://github.com/Flet/semistandard)

Wraps a function and returns one that always returns a promise. API-compatible with bluebird's `Promise.method`.

This promise will resolve with the return value of the passed function. If the passed function throws, the resulting promise will reject. The calling context is preserved in this process, so it can safely wrap object methods.

Accepts an alternate Promise implementation as input if the environment doesn't natively support them.

This module is meant to be a convenient standalone implementation of a Promise utility, but it doesn't provide an alternate Promise constructor and is less than 600 bytes minified and gzipped.

## Example

```js

var method = require('promise-method');

var foo = {

	y: 5,

	bar: method(function (x) {

		return x * this.y;

	})

}

foo.bar(6).then(result => assert(result === 30));

```

## API

```js

function method(fn, Promise)

```

`fn` - a synchronously executed function that may return or throw synchronously. This will be wrapped and returned as a promise-returning function.

`Promise` an alternate Promise implementation to use (perhaps if a global one doesn't exist)