• Packages
  • Themes
  • Documentation
  • Blog
  • Discuss
Sign in
Whoops, there was an error
v1.34.0
v1.33.1
v1.33.0
v1.32.2
v1.32.1
v1.32.0
v1.31.2
v1.31.1
v1.31.0
v1.30.0
v1.29.0
v1.28.2
v1.28.1
v1.28.0
untagged-688de6479cca05b51c00
untagged-2abd5a23b4430027c837
v1.27.2
v1.27.1
v1.27.0
v1.26.1
v1.26.0
v1.25.1
v1.25.0
v1.24.1
v1.24.0
v1.23.3
v1.23.2
v1.23.1
v1.23.0
v1.22.1
v1.22.0
v1.21.2
v1.21.1
v1.21.0
v1.20.1
v1.20.0
v1.19.7
v1.19.6
v1.19.5
v1.19.4
v1.19.3
v1.19.2
v1.19.1
v1.19.0
v1.18.0
v1.17.2
v1.17.1
v1.17.0
v1.16.0
v1.15.0
v1.14.4
v1.14.3
v1.14.2
v1.14.1
v1.14.0
v1.13.1
v1.13.0
v1.12.9
v1.12.8
v1.12.7
v1.12.6
v1.12.5
v1.12.4
v1.12.3
v1.12.2
v1.12.1
v1.12.0
v1.11.2
v1.11.1
v1.11.0
v1.10.2
v1.10.1
v1.10.0
v1.9.9
v1.9.8
v1.9.7
v1.9.6
v1.9.5
v1.9.4
v1.9.3
v1.9.2
v1.9.1
v1.9.0
v1.8.0
v1.7.4
v1.7.3
v1.7.2
v1.7.1
v1.7.0
v1.6.2
v1.6.1
v1.6.0
v1.5.4
v1.5.3
v1.5.2
v1.5.1
v1.5.0
v1.4.3
v1.4.2
v1.4.1
v1.4.0
v1.3.3
v1.3.2
v1.3.1
v1.3.0
v1.2.4
v1.2.3
v1.2.2
v1.2.1
v1.2.0
v1.1.0
v1.0.19
v1.0.18
v1.0.17
v1.0.16
v1.0.15
v1.0.14
v1.0.13
v1.0.12
v1.0.11
v1.0.10
v1.0.9
v1.0.8
v1.0.7
v1.0.6
v1.0.5
v1.0.4
v1.0.3
v1.0.2
v1.0.1
v1.0.0
v0.211.0
v0.210.0
v0.209.0
v0.208.0
v0.207.0
v0.206.0
v0.205.0
v0.204.0
v0.203.0
v0.202.0
v0.201.0
v0.200.0
v0.199.0
v0.198.0
v0.197.0
v0.196.0
v0.195.0
v0.194.0
v0.193.0
v0.192.0
v0.191.0
v0.190.0
v0.189.0
v0.188.0
v0.187.0
Loading…

Essential Classes

  • AtomEnvironment
  • Color
  • CommandRegistry
  • CompositeDisposable
  • Config
  • Decoration
  • DisplayMarker
  • DisplayMarkerLayer
  • Disposable
  • Emitter
  • LayerDecoration
  • MarkerLayer
  • Notification
  • NotificationManager
  • Point
  • Range
  • TextEditor
  • TooltipManager
  • ViewRegistry
  • Workspace
  • WorkspaceCenter

Extended Classes

  • BufferedNodeProcess
  • BufferedProcess
  • Clipboard
  • ContextMenuManager
  • Cursor
  • DeserializerManager
  • Directory
  • Dock
  • File
  • GitRepository
  • Grammar
  • GrammarRegistry
  • Gutter
  • HistoryManager
  • KeymapManager
  • MenuManager
  • Package
  • PackageManager
  • Pane
  • Panel
  • PathWatcher
  • Project
  • ScopeDescriptor
  • Selection
  • StyleManager
  • Task
  • TextBuffer
  • ThemeManager

Task extended

Run a node script in a separate process.

Used by the fuzzy-finder and find in project.

For a real-world example, see the scan-handler and the instantiation of the task.

Examples

In your package code:

{Task} = require 'atom'
 
task = Task.once '/path/to/task-file.coffee', parameter1, parameter2, ->
  console.log 'task has finished'
 
task.on 'some-event-from-the-task', (data) =>
  console.log data.someString # prints 'yep this is it' 

In '/path/to/task-file.coffee':

module.exports = (parameter1, parameter2) ->
  # Indicates that this task will be async. 
  # Call the `callback` to finish the task 
  callback = @async()
 
  emit('some-event-from-the-task', {someString: 'yep this is it'})
 
  callback()

Methods

.once(taskPath, args)

A helper method to easily launch and run a task once.

Argument Description
taskPath

The String path to the CoffeeScript/JavaScript file which exports a single Function to execute.

args

The arguments to pass to the exported function.

Return values

Returns the created Task.

::constructor(taskPath)

Creates a task. You should probably use .once

Argument Description
taskPath

The String path to the CoffeeScript/JavaScript file that exports a single Function to execute.

::start(args, [callback])

Starts the task.

Throws an error if this task has already been terminated or if sending a message to the child process fails.

Argument Description
args

The arguments to pass to the function exported by this task's script.

callback() optional

A Function to call when the task completes.

::send(message)

Send message to the task.

Throws an error if this task has already been terminated or if sending a message to the child process fails.

Argument Description
message

The message to send to the task.

::on(eventName, callback)

Call a function when an event is emitted by the child process

Argument Description
eventName

The String name of the event to handle.

callback()

The Function to call when the event is emitted.

Return values

Returns a Disposable that can be used to stop listening for the event.

::once(taskPath, args)

A helper method to easily launch and run a task once.

Argument Description
taskPath

The String path to the CoffeeScript/JavaScript file which exports a single Function to execute.

args

The arguments to pass to the exported function.

Return values

Returns the created Task.

::terminate()

Forcefully stop the running task.

No more events are emitted once this method is called.

::cancel()

Cancel the running task and emit an event if it was canceled.

Return values

Returns a Boolean indicating whether the task was terminated.

  • Terms of Use
  • Privacy
  • Code of Conduct
  • Releases
  • FAQ
  • Contact
with by