# applescript

> Easily execute arbitrary AppleScript code on OS X through NodeJS.

Latest version **1.0.0** (published 2015-01-28) · 0 weekly downloads

## Install

```sh
npm install applescript
pnpm add applescript
yarn add applescript
bun add applescript
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2015-01-28 |
| First published | 2012-03-09 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Nathan Rajlich |
| Maintainers | TooTallNate, tootallnate |
| Keywords | applescript, mac, osx |

## Links

- npm: https://www.npmjs.com/package/applescript
- npm.io page: https://npm.io/package/applescript

## Recent versions

- 1.0.0 (latest) — 2015-01-28
- 0.1.0 — 2012-03-09
- 0.2.0 — 2012-03-09
- 0.2.1 — 2012-03-09

## README

node-applescript
================

A high-level way to execute AppleScript code through NodeJS, and retrieve
the result as a native JavaScript object. Underneath the hood, this
module is just a simple wrapper around the OS X `osascript` command.

### Why?
AppleScripts are the only way to communicate and interact with certain
external OS X processes, for example [iTunes](http://www.itunes.com).

Easy Install
------------

``` bash
$ npm install applescript
```

Requirements
------------

 * Mac (or Hackintosh) running [OS X](http://www.apple.com/macosx) (tested with Snow Leopard)
 * [NodeJS](http://nodejs.org) (v0.2.0 or newer)

Usage
-----

The `node-applescript` module provides `execString` and `execFile` functions
to easily execute AppleScript commands and buffer the output into a calback.

``` js
var applescript = require('applescript');

// Very basic AppleScript command. Returns the song name of each
// currently selected track in iTunes as an 'Array' of 'String's.
var script = 'tell application "iTunes" to get name of selection';

applescript.execString(script, function(err, rtn) {
  if (err) {
    // Something went wrong!
  }
  if (Array.isArray(rtn)) {
    rtn.forEach(function(songName) {
      console.log(songName);
    });
  }
});
```

`execFile` works the exact same way, except you pass the _path_ of the AppleScript
(`*.applescript`) file as the first argument instead of the command itself, and you
may pass an optional Array of String arguments to send to the applescript file.

Licence
-------

The `node-applescript` module is licensed under the MIT license, of course!

---
_Source: https://npm.io/package/applescript · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._