mirror of
https://github.com/atom/atom.git
synced 2026-01-22 13:28:01 -05:00
965afc2c37
Our new pattern for booleans is to have ::set and ::is, and that means the property name needs to be in passive voice for ::is to make sense. This is in preparation for adding a new change observation method. * ::setSoftWrapped * ::isSoftWrapped * ::toggleSoftWrapped
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
- EditorView
- Git
- Point
- Range
- ScrollView
- SelectListView
- View
- WorkspaceView
- Workspace
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.