https://github.com/wtfaremyinitials/osa2
Interact with Apple's Open Scripting Architecture in node.js
https://github.com/wtfaremyinitials/osa2
javascript-for-automation jxa node nodejs osascript
Last synced: 11 months ago
JSON representation
Interact with Apple's Open Scripting Architecture in node.js
- Host: GitHub
- URL: https://github.com/wtfaremyinitials/osa2
- Owner: wtfaremyinitials
- Created: 2017-04-10T22:37:03.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-03-10T23:17:27.000Z (almost 8 years ago)
- Last Synced: 2025-03-29T02:12:20.707Z (11 months ago)
- Topics: javascript-for-automation, jxa, node, nodejs, osascript
- Language: JavaScript
- Homepage:
- Size: 42 KB
- Stars: 70
- Watchers: 2
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
- awesome-jxa - osa2 - This module provides a Promise interface to macOS's automation and scripting APIs (Node.js helpers)
README
osa2
===
[](https://github.com/prettier/prettier)
> Interact with Apple's Open Scripting Architecture from node.js
This module provides a Promise interface to macOS's automation and scripting APIs.
`osa2` is intended for use in libraries or full applications. If you're looking
to write simple automation scripts, check out [jxa](https://www.npmjs.com/package/jxa).
Installation
===
```bash
npm install osa2 --save
```
Usage
===
Get the currently playing iTunes track
```js
var osa = require('osa2')
var track = osa(() => {
return Application('iTunes').currentTrack.name()
})
track().then(console.log).catch(console.error)
```
Show an alert
```js
var osa = require('osa2')
function alert(message) {
return osa(text => {
var app = Application.currentApplication()
app.includeStandardAdditions = true
app.displayAlert(text)
})(message)
}
alert('Hello World')
```
API
===
### Execute code in the JavaScript for Automation environment
`osa(function) -> function`
Wraps `function` to be run inside Apple's JavaScript for Automation environment.
**function**
Type: `function`
The code to be run inside the JXA environment. ***NOTE:*** `function` cannot close over variables in a parent's scope.
Pass data as arguments explicitly instead.
**return**
Type: `function`
Returns a new function with the same arguments as `function`, but when called
the code is run inside the JXA environment. This is done asynchronously,
therefore promise is returned.
```js
var greet = osa(name => `Hello from JXA, ${name}!`)
greet('Will').then(text => {
console.log(text) // Hello from JXA, Will!
})
```