forked from pulsar-edit/pulsar-edit.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathv1.11.2.json
20967 lines (20967 loc) · 889 KB
/
v1.11.2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"classes": {
"AtomEnvironment": {
"name": "AtomEnvironment",
"superClass": "Model",
"filename": "src/atom-environment.coffee",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L61",
"sections": [
{
"name": "Properties",
"description": ""
},
{
"name": "Event Subscription",
"description": ""
},
{
"name": "Atom Details",
"description": ""
},
{
"name": "Managing The Atom Window",
"description": ""
},
{
"name": "Messaging the User",
"description": ""
},
{
"name": "Managing the Dev Tools",
"description": ""
}
],
"classMethods": [],
"instanceMethods": [
{
"name": "onDidBeep",
"sectionName": "Event Subscription",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L368",
"visibility": "Extended",
"summary": "Invoke the given callback whenever {::beep} is called.",
"description": "Invoke the given callback whenever {::beep} is called.",
"arguments": [
{
"name": "callback",
"description": "{Function} to be called whenever {::beep} is called.",
"type": "Function",
"isOptional": false
}
],
"returnValues": [
{
"type": "Disposable",
"description": "Returns a {Disposable} on which `.dispose()` can be called to unsubscribe."
}
]
},
{
"name": "onWillThrowError",
"sectionName": "Event Subscription",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L384",
"visibility": "Extended",
"summary": "Invoke the given callback when there is an unhandled error, but\nbefore the devtools pop open",
"description": "Invoke the given callback when there is an unhandled error, but\nbefore the devtools pop open",
"arguments": [
{
"children": [
{
"children": [
{
"name": "originalError",
"description": "{Object} the original error object",
"type": "Object",
"isOptional": false
},
{
"name": "message",
"description": "{String} the original error object",
"type": "String",
"isOptional": false
},
{
"name": "url",
"description": "{String} Url to the file where the error originated.",
"type": "String",
"isOptional": false
},
{
"name": "line",
"description": "{Number}",
"type": "Number",
"isOptional": false
},
{
"name": "column",
"description": "{Number}",
"type": "Number",
"isOptional": false
},
{
"name": "preventDefault",
"description": "{Function} call this to avoid popping up the dev tools.",
"type": "Function",
"isOptional": false
}
],
"name": "event",
"description": "{Object}",
"type": "Object",
"isOptional": false
}
],
"name": "callback",
"description": "{Function} to be called whenever there is an unhandled error",
"type": "Function",
"isOptional": false
}
],
"returnValues": [
{
"type": "Disposable",
"description": "Returns a {Disposable} on which `.dispose()` can be called to unsubscribe."
}
]
},
{
"name": "onDidThrowError",
"sectionName": "Event Subscription",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L398",
"visibility": "Extended",
"summary": "Invoke the given callback whenever there is an unhandled error.",
"description": "Invoke the given callback whenever there is an unhandled error.",
"arguments": [
{
"children": [
{
"children": [
{
"name": "originalError",
"description": "{Object} the original error object",
"type": "Object",
"isOptional": false
},
{
"name": "message",
"description": "{String} the original error object",
"type": "String",
"isOptional": false
},
{
"name": "url",
"description": "{String} Url to the file where the error originated.",
"type": "String",
"isOptional": false
},
{
"name": "line",
"description": "{Number}",
"type": "Number",
"isOptional": false
},
{
"name": "column",
"description": "{Number}",
"type": "Number",
"isOptional": false
}
],
"name": "event",
"description": "{Object}",
"type": "Object",
"isOptional": false
}
],
"name": "callback",
"description": "{Function} to be called whenever there is an unhandled error",
"type": "Function",
"isOptional": false
}
],
"returnValues": [
{
"type": "Disposable",
"description": "Returns a {Disposable} on which `.dispose()` can be called to unsubscribe."
}
]
},
{
"name": "inDevMode",
"sectionName": "Atom Details",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L412",
"visibility": "Public",
"summary": "",
"description": "",
"returnValues": [
{
"type": "Boolean",
"description": "Returns a {Boolean} that is `true` if the current window is in development mode."
}
]
},
{
"name": "inSafeMode",
"sectionName": "Atom Details",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L416",
"visibility": "Public",
"summary": "",
"description": "",
"returnValues": [
{
"type": "Boolean",
"description": "Returns a {Boolean} that is `true` if the current window is in safe mode."
}
]
},
{
"name": "inSpecMode",
"sectionName": "Atom Details",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L420",
"visibility": "Public",
"summary": "",
"description": "",
"returnValues": [
{
"type": "Boolean",
"description": "Returns a {Boolean} that is `true` if the current window is running specs."
}
]
},
{
"name": "getVersion",
"sectionName": "Atom Details",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L431",
"visibility": "Public",
"summary": "Get the version of the Atom application.",
"description": "Get the version of the Atom application.",
"returnValues": [
{
"type": "String",
"description": "Returns the version text {String}."
}
]
},
{
"name": "isReleasedVersion",
"sectionName": "Atom Details",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L445",
"visibility": "Public",
"summary": "",
"description": "",
"returnValues": [
{
"type": "Boolean",
"description": "Returns a {Boolean} that is `true` if the current version is an official release."
}
]
},
{
"name": "getWindowLoadTime",
"sectionName": "Atom Details",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L455",
"visibility": "Public",
"summary": "Get the time taken to completely load the current window.",
"description": "Get the time taken to completely load the current window.\n\nThis time include things like loading and activating packages, creating\nDOM elements for the editor, and reading the config.",
"returnValues": [
{
"type": "Number",
"description": "Returns the {Number} of milliseconds taken to load the window or null\nif the window hasn't finished loading yet."
}
]
},
{
"name": "getLoadSettings",
"sectionName": "Atom Details",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L461",
"visibility": "Public",
"summary": "Get the load settings for the current window.",
"description": "Get the load settings for the current window.",
"returnValues": [
{
"type": "Object",
"description": "Returns an {Object} containing all the load setting key/value pairs."
}
]
},
{
"name": "open",
"sectionName": "Managing The Atom Window",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L482",
"visibility": "Essential",
"summary": "Open a new Atom window using the given options.",
"description": "Open a new Atom window using the given options.\n\nCalling this method without an options parameter will open a prompt to pick\na file/folder to open in the new window.",
"arguments": [
{
"children": [
{
"name": "pathsToOpen",
"description": "An {Array} of {String} paths to open.",
"type": "Array",
"isOptional": false
},
{
"name": "newWindow",
"description": "A {Boolean}, true to always open a new window instead of reusing existing windows depending on the paths to open.",
"type": "Boolean",
"isOptional": false
},
{
"name": "devMode",
"description": "A {Boolean}, true to open the window in development mode. Development mode loads the Atom source from the locally cloned repository and also loads all the packages in ~/.atom/dev/packages",
"type": "Boolean",
"isOptional": false
},
{
"name": "safeMode",
"description": "A {Boolean}, true to open the window in safe mode. Safe mode prevents all packages installed to ~/.atom/packages from loading. ",
"type": "Boolean",
"isOptional": false
}
],
"name": "params",
"description": "An {Object} with the following keys:",
"type": "Object",
"isOptional": false
}
]
},
{
"name": "pickFolder",
"sectionName": "Managing The Atom Window",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L490",
"visibility": "Extended",
"summary": "Prompt the user to select one or more folders.",
"description": "Prompt the user to select one or more folders.",
"arguments": [
{
"children": [
{
"name": "paths",
"description": "An {Array} of {String} paths that the user selected, or `null` if the user dismissed the dialog. ",
"type": "Array",
"isOptional": false
}
],
"name": "callback",
"description": "A {Function} to call once the user has confirmed the selection.",
"type": "Function",
"isOptional": false
}
]
},
{
"name": "close",
"sectionName": "Managing The Atom Window",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L494",
"visibility": "Essential",
"summary": "Close the current window. ",
"description": "Close the current window. "
},
{
"name": "getSize",
"sectionName": "Managing The Atom Window",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L500",
"visibility": "Essential",
"summary": "Get the size of current window.",
"description": "Get the size of current window.",
"returnValues": [
{
"type": "Object",
"description": "Returns an {Object} in the format `{width: 1000, height: 700}`"
}
]
},
{
"name": "setSize",
"sectionName": "Managing The Atom Window",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L507",
"visibility": "Essential",
"summary": "Set the size of current window.",
"description": "Set the size of current window.",
"arguments": [
{
"name": "width",
"description": "The {Number} of pixels.",
"type": "Number",
"isOptional": false
},
{
"name": "height",
"description": "The {Number} of pixels. ",
"type": "Number",
"isOptional": false
}
]
},
{
"name": "getPosition",
"sectionName": "Managing The Atom Window",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L513",
"visibility": "Essential",
"summary": "Get the position of current window.",
"description": "Get the position of current window.",
"returnValues": [
{
"type": "Object",
"description": "Returns an {Object} in the format `{x: 10, y: 20}`"
}
]
},
{
"name": "setPosition",
"sectionName": "Managing The Atom Window",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L520",
"visibility": "Essential",
"summary": "Set the position of current window.",
"description": "Set the position of current window.",
"arguments": [
{
"name": "x",
"description": "The {Number} of pixels.",
"type": "Number",
"isOptional": false
},
{
"name": "y",
"description": "The {Number} of pixels. ",
"type": "Number",
"isOptional": false
}
]
},
{
"name": "getCurrentWindow",
"sectionName": "Managing The Atom Window",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L524",
"visibility": "Extended",
"summary": "Get the current window ",
"description": "Get the current window "
},
{
"name": "center",
"sectionName": "Managing The Atom Window",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L528",
"visibility": "Extended",
"summary": "Move current window to the center of the screen. ",
"description": "Move current window to the center of the screen. "
},
{
"name": "focus",
"sectionName": "Managing The Atom Window",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L532",
"visibility": "Extended",
"summary": "Focus the current window. ",
"description": "Focus the current window. "
},
{
"name": "show",
"sectionName": "Managing The Atom Window",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L537",
"visibility": "Extended",
"summary": "Show the current window. ",
"description": "Show the current window. "
},
{
"name": "hide",
"sectionName": "Managing The Atom Window",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L541",
"visibility": "Extended",
"summary": "Hide the current window. ",
"description": "Hide the current window. "
},
{
"name": "reload",
"sectionName": "Managing The Atom Window",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L545",
"visibility": "Extended",
"summary": "Reload the current window. ",
"description": "Reload the current window. "
},
{
"name": "isMaximized",
"sectionName": "Managing The Atom Window",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L549",
"visibility": "Extended",
"summary": "",
"description": "",
"returnValues": [
{
"type": "Boolean",
"description": "Returns a {Boolean} that is `true` if the current window is maximized."
}
]
},
{
"name": "isFullScreen",
"sectionName": "Managing The Atom Window",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L556",
"visibility": "Extended",
"summary": "",
"description": "",
"returnValues": [
{
"type": "Boolean",
"description": "Returns a {Boolean} that is `true` if the current window is in full screen mode."
}
]
},
{
"name": "setFullScreen",
"sectionName": "Managing The Atom Window",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L560",
"visibility": "Extended",
"summary": "Set the full screen state of the current window. ",
"description": "Set the full screen state of the current window. "
},
{
"name": "toggleFullScreen",
"sectionName": "Managing The Atom Window",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L564",
"visibility": "Extended",
"summary": "Toggle the full screen state of the current window. ",
"description": "Toggle the full screen state of the current window. "
},
{
"name": "beep",
"sectionName": "Messaging the User",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L761",
"visibility": "Essential",
"summary": "Visually and audibly trigger a beep. ",
"description": "Visually and audibly trigger a beep. "
},
{
"name": "confirm",
"sectionName": "Messaging the User",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L785",
"visibility": "Essential",
"summary": "A flexible way to open a dialog akin to an alert dialog.",
"description": "A flexible way to open a dialog akin to an alert dialog.",
"arguments": [
{
"children": [
{
"name": "message",
"description": "The {String} message to display.",
"type": "String",
"isOptional": false
},
{
"name": "detailedMessage",
"description": "The {String} detailed message to display.",
"type": "String",
"isOptional": true
},
{
"name": "buttons",
"description": "Either an array of strings or an object where keys are button names and the values are callbacks to invoke when clicked.",
"type": null,
"isOptional": true
}
],
"name": "options",
"description": "An {Object} with the following keys:",
"type": "Object",
"isOptional": false
}
],
"examples": [
{
"description": "",
"lang": "coffee",
"code": "atom.confirm\n message: 'How you feeling?'\n detailedMessage: 'Be honest.'\n buttons:\n Good: -> window.alert('good to hear')\n Bad: -> window.alert('bummer')",
"raw": "```coffee\natom.confirm\n message: 'How you feeling?'\n detailedMessage: 'Be honest.'\n buttons:\n Good: -> window.alert('good to hear')\n Bad: -> window.alert('bummer')\n```"
}
],
"returnValues": [
{
"type": "Number",
"description": "Returns the chosen button index {Number} if the buttons option was an array."
}
]
},
{
"name": "openDevTools",
"sectionName": "Managing the Dev Tools",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L795",
"visibility": "Extended",
"summary": "Open the dev tools for the current window.",
"description": "Open the dev tools for the current window.",
"returnValues": [
{
"type": "Promise",
"description": "Returns a {Promise} that resolves when the DevTools have been opened."
}
]
},
{
"name": "toggleDevTools",
"sectionName": "Managing the Dev Tools",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L802",
"visibility": "Extended",
"summary": "Toggle the visibility of the dev tools for the current window.",
"description": "Toggle the visibility of the dev tools for the current window.",
"returnValues": [
{
"type": "Promise",
"description": "Returns a {Promise} that resolves when the DevTools have been opened or\nclosed."
}
]
},
{
"name": "executeJavaScriptInDevTools",
"sectionName": "Managing the Dev Tools",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L806",
"visibility": "Extended",
"summary": "Execute code in dev tools. ",
"description": "Execute code in dev tools. "
}
],
"classProperties": [],
"instanceProperties": [
{
"name": "commands",
"sectionName": "Properties",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L71",
"visibility": "Public",
"summary": "A {CommandRegistry} instance ",
"description": "A {CommandRegistry} instance "
},
{
"name": "config",
"sectionName": "Properties",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L74",
"visibility": "Public",
"summary": "A {Config} instance ",
"description": "A {Config} instance "
},
{
"name": "clipboard",
"sectionName": "Properties",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L77",
"visibility": "Public",
"summary": "A {Clipboard} instance ",
"description": "A {Clipboard} instance "
},
{
"name": "contextMenu",
"sectionName": "Properties",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L80",
"visibility": "Public",
"summary": "A {ContextMenuManager} instance ",
"description": "A {ContextMenuManager} instance "
},
{
"name": "menu",
"sectionName": "Properties",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L83",
"visibility": "Public",
"summary": "A {MenuManager} instance ",
"description": "A {MenuManager} instance "
},
{
"name": "keymaps",
"sectionName": "Properties",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L86",
"visibility": "Public",
"summary": "A {KeymapManager} instance ",
"description": "A {KeymapManager} instance "
},
{
"name": "tooltips",
"sectionName": "Properties",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L89",
"visibility": "Public",
"summary": "A {TooltipManager} instance ",
"description": "A {TooltipManager} instance "
},
{
"name": "notifications",
"sectionName": "Properties",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L92",
"visibility": "Public",
"summary": "A {NotificationManager} instance ",
"description": "A {NotificationManager} instance "
},
{
"name": "project",
"sectionName": "Properties",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L95",
"visibility": "Public",
"summary": "A {Project} instance ",
"description": "A {Project} instance "
},
{
"name": "grammars",
"sectionName": "Properties",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L98",
"visibility": "Public",
"summary": "A {GrammarRegistry} instance ",
"description": "A {GrammarRegistry} instance "
},
{
"name": "packages",
"sectionName": "Properties",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L101",
"visibility": "Public",
"summary": "A {PackageManager} instance ",
"description": "A {PackageManager} instance "
},
{
"name": "themes",
"sectionName": "Properties",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L104",
"visibility": "Public",
"summary": "A {ThemeManager} instance ",
"description": "A {ThemeManager} instance "
},
{
"name": "styles",
"sectionName": "Properties",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L107",
"visibility": "Public",
"summary": "A {StyleManager} instance ",
"description": "A {StyleManager} instance "
},
{
"name": "deserializers",
"sectionName": "Properties",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L110",
"visibility": "Public",
"summary": "A {DeserializerManager} instance ",
"description": "A {DeserializerManager} instance "
},
{
"name": "views",
"sectionName": "Properties",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L113",
"visibility": "Public",
"summary": "A {ViewRegistry} instance ",
"description": "A {ViewRegistry} instance "
},
{
"name": "workspace",
"sectionName": "Properties",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L116",
"visibility": "Public",
"summary": "A {Workspace} instance ",
"description": "A {Workspace} instance "
},
{
"name": "textEditors",
"sectionName": "Properties",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/atom-environment.coffee#L119",
"visibility": "Public",
"summary": "A {TextEditorRegistry} instance ",
"description": "A {TextEditorRegistry} instance "
}
],
"visibility": "Essential",
"summary": "Atom global for dealing with packages, themes, menus, and the window.",
"description": "Atom global for dealing with packages, themes, menus, and the window.\n\nAn instance of this class is always available as the `atom` global. "
},
"BufferedNodeProcess": {
"name": "BufferedNodeProcess",
"superClass": "BufferedProcess",
"filename": "src/buffered-node-process.coffee",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/buffered-node-process.coffee#L15",
"sections": [],
"classMethods": [],
"instanceMethods": [
{
"name": "constructor",
"sectionName": null,
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/buffered-node-process.coffee#L38",
"visibility": "Public",
"summary": "Runs the given Node script by spawning a new child process.",
"description": "Runs the given Node script by spawning a new child process.",
"arguments": [
{
"children": [
{
"name": "command",
"description": "The {String} path to the JavaScript script to execute.",
"type": "String",
"isOptional": false
},
{
"name": "args",
"description": "The {Array} of arguments to pass to the script (optional).",
"type": "Array",
"isOptional": false
},
{
"name": "options",
"description": "The options {Object} to pass to Node's `ChildProcess.spawn`\n```\n method (optional).\n```",
"type": "Object",
"isOptional": false
},
{
"name": "stdout",
"description": "The callback {Function} that receives a single argument which\n```\n contains the standard output from the command. The callback is\n called as data is received but it's buffered to ensure only\n complete lines are passed until the source stream closes. After\n the source stream has closed all remaining data is sent in a\n final call (optional).\n```",
"type": "Function",
"isOptional": false
},
{
"name": "stderr",
"description": "The callback {Function} that receives a single argument which\n```\n contains the standard error output from the command. The\n callback is called as data is received but it's buffered to\n ensure only complete lines are passed until the source stream\n closes. After the source stream has closed all remaining data\n is sent in a final call (optional).\n```",
"type": "Function",
"isOptional": false
},
{
"name": "exit",
"description": "The callback {Function} which receives a single argument\n```\n containing the exit status (optional).\n```",
"type": "Function",
"isOptional": false
}
],
"name": "options",
"description": "An {Object} with the following keys:",
"type": "Object",
"isOptional": false
}
]
}
],
"classProperties": [],
"instanceProperties": [],
"visibility": "Extended",
"summary": "Like {BufferedProcess}, but accepts a Node script as the command\nto run.",
"description": "Like {BufferedProcess}, but accepts a Node script as the command\nto run.\n\nThis is necessary on Windows since it doesn't support shebang `#!` lines.",
"examples": [
{
"description": "",
"lang": "coffee",
"code": " {BufferedNodeProcess} = require 'atom'",
"raw": "```coffee\n {BufferedNodeProcess} = require 'atom'\n```"
}
]
},
"BufferedProcess": {
"name": "BufferedProcess",
"filename": "src/buffered-process.coffee",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/buffered-process.coffee#L21",
"sections": [
{
"name": "Construction",
"description": ""
},
{
"name": "Event Subscription",
"description": ""
},
{
"name": "Helper Methods",
"description": ""
}
],
"classMethods": [],
"instanceMethods": [
{
"name": "constructor",
"sectionName": "Construction",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/buffered-process.coffee#L48",
"visibility": "Public",
"summary": "Runs the given command by spawning a new child process.",
"description": "Runs the given command by spawning a new child process.",
"arguments": [
{
"children": [
{
"name": "command",
"description": "The {String} command to execute.",
"type": "String",
"isOptional": false
},
{
"name": "args",
"description": "The {Array} of arguments to pass to the command (optional).",
"type": "Array",
"isOptional": false
},
{
"name": "options",
"description": "{Object} (optional) The options {Object} to pass to Node's `ChildProcess.spawn` method.",
"type": "Object",
"isOptional": false
},
{
"children": [
{
"name": "data",
"description": "{String}",
"type": "String",
"isOptional": false
}
],
"name": "stdout",
"description": "{Function} (optional) The callback that receives a single argument which contains the standard output from the command. The callback is called as data is received but it's buffered to ensure only complete lines are passed until the source stream closes. After the source stream has closed all remaining data is sent in a final call.",
"type": "Function",
"isOptional": false
},
{
"children": [
{
"name": "data",
"description": "{String}",
"type": "String",
"isOptional": false
}
],
"name": "stderr",
"description": "{Function} (optional) The callback that receives a single argument which contains the standard error output from the command. The callback is called as data is received but it's buffered to ensure only complete lines are passed until the source stream closes. After the source stream has closed all remaining data is sent in a final call.",
"type": "Function",
"isOptional": false
},
{
"children": [
{
"name": "code",
"description": "{Number} ",
"type": "Number",
"isOptional": false
}
],
"name": "exit",
"description": "{Function} (optional) The callback which receives a single argument containing the exit status.",
"type": "Function",
"isOptional": false
}
],
"name": "options",
"description": "An {Object} with the following keys:",
"type": "Object",
"isOptional": false
}
]
},
{
"name": "onWillThrowError",
"sectionName": "Event Subscription",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/buffered-process.coffee#L96",
"visibility": "Public",
"summary": "Will call your callback when an error will be raised by the process.\nUsually this is due to the command not being available or not on the PATH.\nYou can call `handle()` on the object passed to your callback to indicate\nthat you have handled this error.",
"description": "Will call your callback when an error will be raised by the process.\nUsually this is due to the command not being available or not on the PATH.\nYou can call `handle()` on the object passed to your callback to indicate\nthat you have handled this error.",
"arguments": [
{
"children": [
{
"children": [
{
"name": "error",
"description": "{Object} the error object",
"type": "Object",
"isOptional": false
},
{
"name": "handle",
"description": "{Function} call this to indicate you have handled the error. The error will not be thrown if this function is called.",
"type": "Function",
"isOptional": false
}
],
"name": "errorObject",
"description": "{Object}",
"type": "Object",
"isOptional": false
}
],
"name": "callback",
"description": "{Function} callback",
"type": "Function",
"isOptional": false
}
],
"returnValues": [
{
"type": "Disposable",
"description": "Returns a {Disposable}"
}
]
},
{
"name": "kill",
"sectionName": "Helper Methods",
"srcUrl": "https://github.com/atom/atom/blob/v1.11.2/src/buffered-process.coffee#L185",
"visibility": "Public",
"summary": "Terminate the process. ",
"description": "Terminate the process. "
}
],
"classProperties": [],
"instanceProperties": [],
"visibility": "Extended",
"summary": "A wrapper which provides standard error/output line buffering for\nNode's ChildProcess.",
"description": "A wrapper which provides standard error/output line buffering for\nNode's ChildProcess.",
"examples": [
{
"description": "",
"lang": "coffee",
"code": "{BufferedProcess} = require 'atom'\n\ncommand = 'ps'\nargs = ['-ef']\nstdout = (output) -> console.log(output)\nexit = (code) -> console.log(\"ps -ef exited with #{code}\")\nprocess = new BufferedProcess({command, args, stdout, exit})",
"raw": "```coffee\n{BufferedProcess} = require 'atom'\n\ncommand = 'ps'\nargs = ['-ef']\nstdout = (output) -> console.log(output)\nexit = (code) -> console.log(\"ps -ef exited with #{code}\")\nprocess = new BufferedProcess({command, args, stdout, exit})\n```"