photoshopAction

Edit in GitHub Log an issue

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;

Index

Functions

addNotificationListener

▸ addNotificationListener(events: NotificationEvent[], notifier: NotificationListener): 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([{ event: 'open' }], onOpenNewDocument)
Copied to your clipboard
await PhotoshopAction.addNotificationListener([{ event: 'open' }], onOpenNewDocument)

Parameters:

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

batchPlay

▸ batchPlay(commands: ActionDescriptor[], options?: BatchPlayCommandOptions): 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
var target = { _ref: 'layer', _enum: 'ordinal', _value: 'targetEnum'}
var commands = [{ _obj: 'hide', _target: target }]
await PhotoshopAction.batchPlay(commands)

Parameters:

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

removeNotificationListener

▸ removeNotificationListener(events: NotificationEvent[], notifier: NotificationListener): Promise‹void›

Detaches a listener from a Photoshop event.

see addNotificationListener

await PhotoshopAction.removeNotificationListener([{ event: 'open' }], onOpenNewDocument)
Copied to your clipboard
await PhotoshopAction.removeNotificationListener([{ event: 'open' }], onOpenNewDocument)