Skip to content

Latest commit

 

History

History
104 lines (73 loc) · 3.01 KB

README.md

File metadata and controls

104 lines (73 loc) · 3.01 KB
Raw

NP Dev: async proxy utils

This package contains a set of utilities for working with Metoer methods and other Meteor APIs, in a way that feels more natural, using async/await instead of callbacks.

Install it from atmosphere:

meteor add npdev:async-proxy

Available utilities:

callAsync

import { callAsync } from 'meteor/npdev:async-proxy'

This function allows you to call a method using async/await (it returns a Promise) like:

try {
  await callAsync('methodName', 'arg1', 'arg2')
} catch (error) {
  console.error(error)
}

This is an improvement! No more callbacks. But we can do better! It's still a little weird to invoke a method with a string, so:

Methods

import { Methods } from 'meteor/npdev:async-proxy'

Methods is a Proxy, which allows a more natural invocation of remote methods:

try {
  var result = await Methods.methodName('arg1', 'arg2')
} catch (error) {
  console.error(error)
}

Note: Methods is a Proxy, and requires native Proxy support. It will not work in older browsers.

MeteorAsync

import { MeteorAsync } from 'meteor/npdev:async-proxy'

But what about non-methods - it'd be nice to have async there too. MeteorAsync is another proxy for the Meteor object as a whole. Note: MeteorAsync does not attempt any sort of correctness check. It works as a simple pass-through to to the wrapped object's properties, and assumes you've accessed a callback style function.

try {
  var result = await MeteorAsync.loginWithPassword('username', 'password')
} catch (error) {
  console.error(error)
}

Note: Methods is a Proxy, and requires native Proxy support. It will not work in older browsers.

getPromise

import { getPromise } from 'meteor/npdev:async-proxy'

getPromise can be used to make a promise call from any callback style function.

await getPromise(Accounts.createUser, { username, password, email })

getProxy

import { getProxy } from 'meteor/npdev:async-proxy'

getProxy can be used to proxy the callback style methods on any object.

Note: getProxy does not attempt any sort of correctness check. It works as a simple pass-through to to the wrapped object's properties, and assumes you've accessed a callback style function.

import { getProxy } from 'meteor/npdev:async-proxy'
const AccountsAsync = getProxy(Accounts)
await AccountsAsync.createUser({ username, password, email })

Note: Requires native Proxy support. It will not work in older browsers.

Limitations in Legacy Browsers

An earlier version of this readme incorrectly claimed that Google Chrome's proxy-polyfill could be used to make the Methods proxy function, but it cannot. The polyfill only works with properties defined at specification time. Since we don't have a list of all methods, the Proxy cannot work. If you need support for older browsers (like IE), you can still use the non-proxy based methods, like callAsync and getPromise.