sindresorhus/run-applescript

Run AppleScript and get the result

run-applescript

Run AppleScript and get the result

Install

npm install run-applescript

Usage

import {runAppleScript} from 'run-applescript';

const result = await runAppleScript('return "unicorn"');

console.log(result);
//=> 'unicorn'

API

runAppleScript(script, options?)

Returns a Promise<string> with the script result.

script

Type: string

The script to run.

options

Type: object

humanReadableOutput

Type: boolean
Default: true

Change the output style.

When false, returns the value in a recompilable source form.

runAppleScriptSync(script, options?)

Returns a string with the script result.

script

Type: string

The script to run.

options

Type: object

humanReadableOutput

Type: boolean
Default: true

Change the output style.

When false, returns the value in a recompilable source form.

Related

• run-jxa - Run JXA code and get the result

run-applescript's Issues

Abort execution?

Would it be possible to make this abortable by passing an AbortController on to execa?

const abortController = new AbortController();
const options = {signal: abortController.signal};
const result = await runAppleScript(scpt, [], options);

and in runAppleScript:

export async function runAppleScript(script, {humanReadableOutput = true} = {}, options) {
// ...
const {stdout} = await execa('osascript', ['-e', script, outputArguments], options);

Support for scripts that returns an array?

Typescript support

You probably forgot to add the typescript files to npm.

Can this be used with Electron?

How can I properly import this with electron?

The readme here describes that to use run-applescript you should import it, like:
import { runAppleScriptAsync } from 'run-applescript';

However, in Electron this leads to the error:
SyntaxError: Cannot use import statement outside a module

If I try to change the syntax to:
const { runAppleScriptAsync }= require('run-applescript')

This code produces this error:
Must use import to load ES Module

Cannot read property 'signals' of undefined

Hello I update from 4.0.0 to 5.0.0 and I got this error

any clue ?

Node.js bindings insead of child process

I see there are JavaScript libraries for displaying notifications, for example:
https://developer.apple.com/library/archive/documentation/LanguagesUtilities/Conceptual/MacAutomationScriptingGuide/DisplayNotifications.html

anyone know if there is a way to call the libs directly from JavaScript / Node.js, without launching a child process?