JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 14041
  • Score
    100M100P100Q127496F
  • License MIT

Run JXA (macOS JavaScript for Automation) code and get the result

Package Exports

  • run-jxa

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (run-jxa) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

run-jxa Build Status

Run JXA (macOS JavaScript for Automation) code and get the result

Requires macOS 10.10 or later.

Install

$ npm install --save run-jxa

Usage

Use a function:

const runJxa = require('run-jxa');

runJxa((unicorn, horse) => {
    // this is run in the JXA engine
    return `I love ${unicorn} & ${horse}`;
}, ['🦄', '🐴']).then(result => {
    console.log(result);
    //=> 'I love 🦄 & 🐴'
});

Or a string:

const runJxa = require('run-jxa');

runJxa(`
    const [unicorn, horse] = args;
    return \`I love \${unicorn} & \${horse}\`;
`, ['🦄', '🐴']).then(result => {
    console.log(result);
    //=> 'I love 🦄 & 🐴'
});

runJxa(input, [arguments])

Returns a Promise for the value returned from input.

runJxa.sync(input, [arguments])

Returns the value returned from input.

input

Type: Function string

If a function, it's stringified and passed to JXA. It should be atomic, meaning it doesn't access anything outside its body.

If a string, you can access the specified arguments with args array. Use the arguments parameter rather than template interpolation so you don't have to do escaping.

You can console.log inside input. It will be forwarded to stdout. Useful for debugging.

Note: The JXA context is completely synchronous, so asynchronous functions like setTimeout are not available.

arguments

Type: Array

Arguments to pass to the JXA context. Items should be serializable (JSON.stringify'able).

License

MIT © Sindre Sorhus