photoshopAction

The module that facilitates Actions being performed in the UXP-Photoshop world. You may perform your own batchPlay commands, or attach listeners using this module.

var PhotoshopAction = require('photoshop').action;
Copied to your clipboard
var PhotoshopAction = require('photoshop').action;

Functions#

addNotificationListener#

Promise<void>

Attach a listener to a Photoshop event. A callback in the form of (eventName: string, descriptor: Descriptor) => void will be performed.

await PhotoshopAction.addNotificationListener(['open'], onOpenNewDocument)
Copied to your clipboard
await PhotoshopAction.addNotificationListener(['open'], onOpenNewDocument)

Parameters#

Name	Type
`events`	string[]
`notifier`	NotificationListener

batchPlay#

Promise<ActionDescriptor[]>

Performs a batchPlay call with the provided commands. Equivalent to an executeAction in ExtendScript.

var target = { _ref: 'layer', _enum: 'ordinal', _value: 'targetEnum'}
var commands = [{ _obj: 'hide', _target: target }]
await PhotoshopAction.batchPlay(commands)
Copied to your clipboard
1var target = { _ref: 'layer', _enum: 'ordinal', _value: 'targetEnum'}
2var commands = [{ _obj: 'hide', _target: target }]
3await PhotoshopAction.batchPlay(commands)

Parameters#

Name	Type
`commands`	ActionDescriptor[]
`options?`	BatchPlayCommandOptions

batchPlaySync#

ActionDescriptor[]

Performs a batchPlay call with the provided commands. Equivalent to an executeAction in ExtendScript.

var target = { _ref: 'layer', _enum: 'ordinal', _value: 'targetEnum'}
var commands = [{ _obj: 'hide', _target: target }]
await PhotoshopAction.batchPlay(commands)
Copied to your clipboard
1var target = { _ref: 'layer', _enum: 'ordinal', _value: 'targetEnum'}
2var commands = [{ _obj: 'hide', _target: target }]
3await PhotoshopAction.batchPlay(commands)

Parameters#

Name	Type
`commands`	ActionDescriptor[]
`options?`	BatchPlayCommandOptions

removeNotificationListener#

Promise<void>

Detaches a listener from a Photoshop event.

Parameters#

Name	Type
`events`	string[]
`notifier`	NotificationListener

validateReference#

boolean

Synchronously validates the given action reference, returning true if it still exists. For example, calling this with a closed document would return false.