pulsar/docs

Welcome to the Atom API Documentation

FAQ

Where do I start?

Check out EditorView and Editor classes for a good overview of the main editor API.

How do I access these classes?

Check out the Atom class docs to see what globals are available and what they provide.

You can also require many of these classes in your package via:

{EditorView} = require 'atom'

The classes available from require 'atom' are:

• BufferedProcess
• BufferedNodeProcess
• Directory
• EditorView
• File
• Git
• Point
• Range
• ScrollView
• SelectListView
• View
• WorkspaceView

How do I create a package?

You probably want to read the creating a package doc first and come back here when you are done.

Where are the node docs?

Atom ships with node 0.11.10 and the comprehensive node API docs are available here.