-
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathember-data-docs.json
9153 lines (9153 loc) · 470 KB
/
ember-data-docs.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
{
"project": {},
"files": {
"addon/-private/adapters/build-url-mixin.js": {
"name": "addon/-private/adapters/build-url-mixin.js",
"modules": {},
"classes": {
"DS.BuildURLMixin": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/-private/ext/date.js": {
"name": "addon/-private/ext/date.js",
"modules": {},
"classes": {
"Ember.Date": 1
},
"fors": {},
"namespaces": {
"Ember": 1
}
},
"addon/-private/system/debug/debug-adapter.js": {
"name": "addon/-private/system/debug/debug-adapter.js",
"modules": {},
"classes": {},
"fors": {},
"namespaces": {}
},
"addon/-private/system/debug/debug-info.js": {
"name": "addon/-private/system/debug/debug-info.js",
"modules": {},
"classes": {},
"fors": {
"DS.Model": 1
},
"namespaces": {}
},
"addon/-private/system/model/attr.js": {
"name": "addon/-private/system/model/attr.js",
"modules": {},
"classes": {},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/-private/system/model/errors.js": {
"name": "addon/-private/system/model/errors.js",
"modules": {},
"classes": {
"DS.Errors": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/-private/system/model/model.js": {
"name": "addon/-private/system/model/model.js",
"modules": {},
"classes": {},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/-private/system/model/states.js": {
"name": "addon/-private/system/model/states.js",
"modules": {},
"classes": {
"DS.RootState": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/-private/system/record-arrays/adapter-populated-record-array.js": {
"name": "addon/-private/system/record-arrays/adapter-populated-record-array.js",
"modules": {},
"classes": {
"DS.AdapterPopulatedRecordArray": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/-private/system/record-arrays/filtered-record-array.js": {
"name": "addon/-private/system/record-arrays/filtered-record-array.js",
"modules": {},
"classes": {
"DS.FilteredRecordArray": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/-private/system/record-arrays/record-array.js": {
"name": "addon/-private/system/record-arrays/record-array.js",
"modules": {},
"classes": {
"DS.RecordArray": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/-private/system/references/belongs-to.js": {
"name": "addon/-private/system/references/belongs-to.js",
"modules": {},
"classes": {
"DS.BelongsToReference": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/-private/system/references/record.js": {
"name": "addon/-private/system/references/record.js",
"modules": {},
"classes": {
"DS.RecordReference": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/-private/system/relationships/belongs-to.js": {
"name": "addon/-private/system/relationships/belongs-to.js",
"modules": {},
"classes": {},
"fors": {
"DS": 1
},
"namespaces": {}
},
"addon/-private/system/relationships/ext.js": {
"name": "addon/-private/system/relationships/ext.js",
"modules": {},
"classes": {
"DS.Model": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/-private/system/relationships/has-many.js": {
"name": "addon/-private/system/relationships/has-many.js",
"modules": {},
"classes": {},
"fors": {
"DS": 1
},
"namespaces": {}
},
"addon/-private/system/debug.js": {
"name": "addon/-private/system/debug.js",
"modules": {},
"classes": {},
"fors": {},
"namespaces": {}
},
"addon/-private/system/many-array.js": {
"name": "addon/-private/system/many-array.js",
"modules": {},
"classes": {
"DS.ManyArray": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/-private/system/model.js": {
"name": "addon/-private/system/model.js",
"modules": {},
"classes": {},
"fors": {},
"namespaces": {}
},
"addon/-private/system/normalize-model-name.js": {
"name": "addon/-private/system/normalize-model-name.js",
"modules": {},
"classes": {},
"fors": {
"DS": 1
},
"namespaces": {}
},
"addon/-private/system/promise-proxies.js": {
"name": "addon/-private/system/promise-proxies.js",
"modules": {},
"classes": {
"DS.PromiseArray": 1,
"DS.PromiseObject": 1,
"DS.PromiseManyArray": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/-private/system/record-array-manager.js": {
"name": "addon/-private/system/record-array-manager.js",
"modules": {},
"classes": {
"DS.RecordArrayManager": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/-private/system/record-arrays.js": {
"name": "addon/-private/system/record-arrays.js",
"modules": {},
"classes": {},
"fors": {},
"namespaces": {}
},
"addon/-private/system/snapshot-record-array.js": {
"name": "addon/-private/system/snapshot-record-array.js",
"modules": {},
"classes": {
"DS.SnapshotRecordArray": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/-private/system/snapshot.js": {
"name": "addon/-private/system/snapshot.js",
"modules": {},
"classes": {
"DS.Snapshot": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/-private/system/store.js": {
"name": "addon/-private/system/store.js",
"modules": {},
"classes": {
"DS.Store": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/-private/transforms/boolean.js": {
"name": "addon/-private/transforms/boolean.js",
"modules": {},
"classes": {
"DS.BooleanTransform": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/-private/transforms/date.js": {
"name": "addon/-private/transforms/date.js",
"modules": {},
"classes": {
"DS.DateTransform": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/-private/transforms/number.js": {
"name": "addon/-private/transforms/number.js",
"modules": {},
"classes": {
"DS.NumberTransform": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/-private/transforms/string.js": {
"name": "addon/-private/transforms/string.js",
"modules": {},
"classes": {
"DS.StringTransform": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/-private/adapters.js": {
"name": "addon/-private/adapters.js",
"modules": {},
"classes": {},
"fors": {},
"namespaces": {}
},
"addon/-private/core.js": {
"name": "addon/-private/core.js",
"modules": {},
"classes": {
"DS": 1
},
"fors": {},
"namespaces": {}
},
"addon/-private/serializers.js": {
"name": "addon/-private/serializers.js",
"modules": {},
"classes": {},
"fors": {},
"namespaces": {}
},
"addon/adapters/errors.js": {
"name": "addon/adapters/errors.js",
"modules": {},
"classes": {
"DS.AdapterError": 1,
"DS.InvalidError": 1,
"DS.TimeoutError": 1,
"DS.AbortError": 1,
"DS.UnauthorizedError": 1,
"DS.ForbiddenError": 1,
"DS.NotFoundError": 1,
"DS.ConflictError": 1,
"DS.ServerError": 1
},
"fors": {
"DS": 1
},
"namespaces": {
"DS": 1
}
},
"addon/adapters/json-api.js": {
"name": "addon/adapters/json-api.js",
"modules": {},
"classes": {
"DS.JSONAPIAdapter": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/adapters/rest.js": {
"name": "addon/adapters/rest.js",
"modules": {},
"classes": {
"DS.RESTAdapter": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/serializers/embedded-records-mixin.js": {
"name": "addon/serializers/embedded-records-mixin.js",
"modules": {},
"classes": {
"DS.EmbeddedRecordsMixin": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/serializers/json-api.js": {
"name": "addon/serializers/json-api.js",
"modules": {},
"classes": {
"DS.JSONAPISerializer": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/serializers/json.js": {
"name": "addon/serializers/json.js",
"modules": {},
"classes": {
"DS.JSONSerializer": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/serializers/rest.js": {
"name": "addon/serializers/rest.js",
"modules": {},
"classes": {
"DS.RESTSerializer": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/adapter.js": {
"name": "addon/adapter.js",
"modules": {},
"classes": {
"DS.Adapter": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/attr.js": {
"name": "addon/attr.js",
"modules": {},
"classes": {},
"fors": {
"DS": 1
},
"namespaces": {}
},
"addon/index.js": {
"name": "addon/index.js",
"modules": {
"ember-data": 1
},
"classes": {},
"fors": {},
"namespaces": {}
},
"addon/relationships.js": {
"name": "addon/relationships.js",
"modules": {},
"classes": {},
"fors": {},
"namespaces": {}
},
"addon/serializer.js": {
"name": "addon/serializer.js",
"modules": {},
"classes": {
"DS.Serializer": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"addon/transform.js": {
"name": "addon/transform.js",
"modules": {},
"classes": {
"DS.Transform": 1
},
"fors": {},
"namespaces": {
"DS": 1
}
},
"node_modules/ember-inflector/addon/lib/ext/string.js": {
"name": "node_modules/ember-inflector/addon/lib/ext/string.js",
"modules": {},
"classes": {},
"fors": {
"String": 1,
"DS.String": 1
},
"namespaces": {}
},
"node_modules/ember-inflector/addon/lib/helpers/pluralize.js": {
"name": "node_modules/ember-inflector/addon/lib/helpers/pluralize.js",
"modules": {},
"classes": {},
"fors": {
"Ember.HTMLBars.helpers": 1
},
"namespaces": {}
},
"node_modules/ember-inflector/addon/lib/helpers/singularize.js": {
"name": "node_modules/ember-inflector/addon/lib/helpers/singularize.js",
"modules": {},
"classes": {},
"fors": {
"Ember.HTMLBars.helpers": 1
},
"namespaces": {}
},
"node_modules/ember-inflector/addon/lib/system/inflector.js": {
"name": "node_modules/ember-inflector/addon/lib/system/inflector.js",
"modules": {},
"classes": {
"Ember.Inflector": 1
},
"fors": {},
"namespaces": {
"Ember": 1
}
}
},
"modules": {
"ember-data": {
"name": "ember-data",
"submodules": {},
"elements": {},
"classes": {
"DS.BuildURLMixin": 1,
"Ember.Date": 1,
"DS.Model": 1,
"DS.Errors": 1,
"DS.RootState": 1,
"DS.AdapterPopulatedRecordArray": 1,
"DS.FilteredRecordArray": 1,
"DS.RecordArray": 1,
"DS.BelongsToReference": 1,
"DS.RecordReference": 1,
"DS": 1,
"DS.ManyArray": 1,
"DS.PromiseArray": 1,
"DS.PromiseObject": 1,
"DS.PromiseManyArray": 1,
"DS.RecordArrayManager": 1,
"DS.SnapshotRecordArray": 1,
"DS.Snapshot": 1,
"DS.Store": 1,
"DS.BooleanTransform": 1,
"DS.DateTransform": 1,
"DS.NumberTransform": 1,
"DS.StringTransform": 1,
"DS.AdapterError": 1,
"DS.InvalidError": 1,
"DS.TimeoutError": 1,
"DS.AbortError": 1,
"DS.UnauthorizedError": 1,
"DS.ForbiddenError": 1,
"DS.NotFoundError": 1,
"DS.ConflictError": 1,
"DS.ServerError": 1,
"DS.JSONAPIAdapter": 1,
"DS.RESTAdapter": 1,
"DS.EmbeddedRecordsMixin": 1,
"DS.JSONAPISerializer": 1,
"DS.JSONSerializer": 1,
"DS.RESTSerializer": 1,
"DS.Adapter": 1,
"DS.Serializer": 1,
"DS.Transform": 1,
"DS.String": 1,
"DS.Ember.HTMLBars.helpers": 1,
"Ember.HTMLBars.helpers": 1,
"Ember.Inflector": 1
},
"fors": {
"DS.Model": 1,
"DS": 1,
"String": 1,
"DS.String": 1,
"Ember.HTMLBars.helpers": 1
},
"namespaces": {
"Ember": 1,
"DS": 1
},
"tag": "main",
"file": "node_modules/ember-inflector/addon/lib/system/inflector.js",
"line": 32,
"description": "Ember Data",
"itemtype": "main"
}
},
"classes": {
"DS.BuildURLMixin": {
"name": "DS.BuildURLMixin",
"shortname": "DS.BuildURLMixin",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [
"DS.RESTAdapter"
],
"module": "ember-data",
"namespace": "DS",
"file": "addon/-private/adapters/build-url-mixin.js",
"line": 5,
"description": "WARNING: This interface is likely to change in order to accomodate https://github.com/emberjs/rfcs/pull/4\n## Using BuildURLMixin\nTo use url building, include the mixin when extending an adapter, and call `buildURL` where needed.\n The default behaviour is designed for RESTAdapter.\n### Example\n```javascript\n export default DS.Adapter.extend(BuildURLMixin, {\n findRecord: function(store, type, id, snapshot) {\n var url = this.buildURL(type.modelName, id, snapshot, 'findRecord');\n return this.ajax(url, 'GET');\n }\n });\n ```\n### Attributes\nThe `host` and `namespace` attributes will be used if defined, and are optional."
},
"Ember.Date": {
"name": "Ember.Date",
"shortname": "Ember.Date",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "Ember",
"file": "addon/-private/ext/date.js",
"line": 9,
"description": "Date.parse with progressive enhancement for ISO 8601 <https://github.com/csnover/js-iso8601>\n\n© 2011 Colin Snover <http://zetafleet.com>\n\nReleased under MIT license.",
"static": 1,
"deprecated": true
},
"DS.Model": {
"name": "DS.Model",
"shortname": "DS.Model",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/-private/system/relationships/ext.js",
"line": 96,
"description": "The model class that all Ember Data records descend from.\n This is the public API of Ember Data models. If you are using Ember Data\n in your application, this is the class you should use.\n If you are working on Ember Data internals, you most likely want to be dealing\n with `InternalModel`",
"extends": "Ember.Object",
"uses": [
"Ember.Evented"
]
},
"DS.Errors": {
"name": "DS.Errors",
"shortname": "DS.Errors",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/-private/system/model/errors.js",
"line": 15,
"description": "Holds validation errors for a given record, organized by attribute names.\n\nEvery `DS.Model` has an `errors` property that is an instance of\n`DS.Errors`. This can be used to display validation error\nmessages returned from the server when a `record.save()` rejects.\n\nFor Example, if you had a `User` model that looked like this:\n\n```app/models/user.js\nimport DS from 'ember-data';\n\nexport default DS.Model.extend({\n username: attr('string'),\n email: attr('string')\n});\n```\nAnd you attempted to save a record that did not validate on the backend:\n\n```javascript\nvar user = store.createRecord('user', {\n username: 'tomster',\n email: 'invalidEmail'\n});\nuser.save();\n```\n\nYour backend would be expected to return an error response that described\nthe problem, so that error messages can be generated on the app.\n\nAPI responses will be translated into instances of `DS.Errors` differently,\ndepending on the specific combination of adapter and serializer used. You\nmay want to check the documentation or the source code of the libraries\nthat you are using, to know how they expect errors to be communicated.\n\nErrors can be displayed to the user by accessing their property name\nto get an array of all the error objects for that property. Each\nerror object is a JavaScript object with two keys:\n\n- `message` A string containing the error message from the backend\n- `attribute` The name of the property associated with this error message\n\n```handlebars\n<label>Username: {{input value=username}} </label>\n{{#each model.errors.username as |error|}}\n <div class=\"error\">\n {{error.message}}\n </div>\n{{/each}}\n\n<label>Email: {{input value=email}} </label>\n{{#each model.errors.email as |error|}}\n <div class=\"error\">\n {{error.message}}\n </div>\n{{/each}}\n```\n\nYou can also access the special `messages` property on the error\nobject to get an array of all the error strings.\n\n```handlebars\n{{#each model.errors.messages as |message|}}\n <div class=\"error\">\n {{message}}\n </div>\n{{/each}}\n```",
"extends": "Ember.Object",
"uses": [
"Ember.Enumerable",
"Ember.Evented"
]
},
"DS.RootState": {
"name": "DS.RootState",
"shortname": "DS.RootState",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/-private/system/model/states.js",
"line": 10,
"description": "### State\n\nEach record has a `currentState` property that explicitly tracks what\nstate a record is in at any given time. For instance, if a record is\nnewly created and has not yet been sent to the adapter to be saved,\nit would be in the `root.loaded.created.uncommitted` state. If a\nrecord has had local modifications made to it that are in the\nprocess of being saved, the record would be in the\n`root.loaded.updated.inFlight` state. (This state paths will be\nexplained in more detail below.)\n\nEvents are sent by the record or its store to the record's\n`currentState` property. How the state reacts to these events is\ndependent on which state it is in. In some states, certain events\nwill be invalid and will cause an exception to be raised.\n\nStates are hierarchical and every state is a substate of the\n`RootState`. For example, a record can be in the\n`root.deleted.uncommitted` state, then transition into the\n`root.deleted.inFlight` state. If a child state does not implement\nan event handler, the state manager will attempt to invoke the event\non all parent states until the root state is reached. The state\nhierarchy of a record is described in terms of a path string. You\ncan determine a record's current state by getting the state's\n`stateName` property:\n\n```javascript\nrecord.get('currentState.stateName');\n//=> \"root.created.uncommitted\"\n ```\n\nThe hierarchy of valid states that ship with ember data looks like\nthis:\n\n```text\n* root\n * deleted\n * saved\n * uncommitted\n * inFlight\n * empty\n * loaded\n * created\n * uncommitted\n * inFlight\n * saved\n * updated\n * uncommitted\n * inFlight\n * loading\n```\n\nThe `DS.Model` states are themselves stateless. What that means is\nthat, the hierarchical states that each of *those* points to is a\nshared data structure. For performance reasons, instead of each\nrecord getting its own copy of the hierarchy of states, each record\npoints to this global, immutable shared instance. How does a state\nknow which record it should be acting on? We pass the record\ninstance into the state's event handlers as the first argument.\n\nThe record passed as the first parameter is where you should stash\nstate about the record if needed; you should never store data on the state\nobject itself.\n\n### Events and Flags\n\nA state may implement zero or more events and flags.\n\n#### Events\n\nEvents are named functions that are invoked when sent to a record. The\nrecord will first look for a method with the given name on the\ncurrent state. If no method is found, it will search the current\nstate's parent, and then its grandparent, and so on until reaching\nthe top of the hierarchy. If the root is reached without an event\nhandler being found, an exception will be raised. This can be very\nhelpful when debugging new features.\n\nHere's an example implementation of a state with a `myEvent` event handler:\n\n```javascript\naState: DS.State.create({\n myEvent: function(manager, param) {\n console.log(\"Received myEvent with\", param);\n }\n})\n```\n\nTo trigger this event:\n\n```javascript\nrecord.send('myEvent', 'foo');\n//=> \"Received myEvent with foo\"\n```\n\nNote that an optional parameter can be sent to a record's `send()` method,\nwhich will be passed as the second parameter to the event handler.\n\nEvents should transition to a different state if appropriate. This can be\ndone by calling the record's `transitionTo()` method with a path to the\ndesired state. The state manager will attempt to resolve the state path\nrelative to the current state. If no state is found at that path, it will\nattempt to resolve it relative to the current state's parent, and then its\nparent, and so on until the root is reached. For example, imagine a hierarchy\nlike this:\n\n * created\n * uncommitted <-- currentState\n * inFlight\n * updated\n * inFlight\n\nIf we are currently in the `uncommitted` state, calling\n`transitionTo('inFlight')` would transition to the `created.inFlight` state,\nwhile calling `transitionTo('updated.inFlight')` would transition to\nthe `updated.inFlight` state.\n\nRemember that *only events* should ever cause a state transition. You should\nnever call `transitionTo()` from outside a state's event handler. If you are\ntempted to do so, create a new event and send that to the state manager.\n\n#### Flags\n\nFlags are Boolean values that can be used to introspect a record's current\nstate in a more user-friendly way than examining its state path. For example,\ninstead of doing this:\n\n```javascript\nvar statePath = record.get('stateManager.currentPath');\nif (statePath === 'created.inFlight') {\n doSomething();\n}\n```\n\nYou can say:\n\n```javascript\nif (record.get('isNew') && record.get('isSaving')) {\n doSomething();\n}\n```\n\nIf your state does not set a value for a given flag, the value will\nbe inherited from its parent (or the first place in the state hierarchy\nwhere it is defined).\n\nThe current set of flags are defined below. If you want to add a new flag,\nin addition to the area below, you will also need to declare it in the\n`DS.Model` class.\n\n\n * [isEmpty](DS.Model.html#property_isEmpty)\n * [isLoading](DS.Model.html#property_isLoading)\n * [isLoaded](DS.Model.html#property_isLoaded)\n * [hasDirtyAttributes](DS.Model.html#property_hasDirtyAttributes)\n * [isSaving](DS.Model.html#property_isSaving)\n * [isDeleted](DS.Model.html#property_isDeleted)\n * [isNew](DS.Model.html#property_isNew)\n * [isValid](DS.Model.html#property_isValid)"
},
"DS.AdapterPopulatedRecordArray": {
"name": "DS.AdapterPopulatedRecordArray",
"shortname": "DS.AdapterPopulatedRecordArray",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/-private/system/record-arrays/adapter-populated-record-array.js",
"line": 11,
"description": "Represents an ordered list of records whose order and membership is\ndetermined by the adapter. For example, a query sent to the adapter\nmay trigger a search on the server, whose results would be loaded\ninto an instance of the `AdapterPopulatedRecordArray`.\n\n---\n\nIf you want to update the array and get the latest records from the\nadapter, you can invoke [`update()`](#method_update):\n\nExample\n\n```javascript\n// GET /users?isAdmin=true\nvar admins = store.query('user', { isAdmin: true });\n\nadmins.then(function() {\n console.log(admins.get(\"length\")); // 42\n});\n\n// somewhere later in the app code, when new admins have been created\n// in the meantime\n//\n// GET /users?isAdmin=true\nadmins.update().then(function() {\n admins.get('isUpdating'); // false\n console.log(admins.get(\"length\")); // 123\n});\n\nadmins.get('isUpdating'); // true\n```",
"extends": "DS.RecordArray"
},
"DS.FilteredRecordArray": {
"name": "DS.FilteredRecordArray",
"shortname": "DS.FilteredRecordArray",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/-private/system/record-arrays/filtered-record-array.js",
"line": 10,
"description": "Represents a list of records whose membership is determined by the\nstore. As records are created, loaded, or modified, the store\nevaluates them to determine if they should be part of the record\narray.",
"extends": "DS.RecordArray"
},
"DS.RecordArray": {
"name": "DS.RecordArray",
"shortname": "DS.RecordArray",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/-private/system/record-arrays/record-array.js",
"line": 11,
"description": "A record array is an array that contains records of a certain type. The record\narray materializes records as needed when they are retrieved for the first\ntime. You should not create record arrays yourself. Instead, an instance of\n`DS.RecordArray` or its subclasses will be returned by your application's store\nin response to queries.",
"extends": "Ember.ArrayProxy",
"uses": [
"Ember.Evented"
]
},
"DS.BelongsToReference": {
"name": "DS.BelongsToReference",
"shortname": "DS.BelongsToReference",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/-private/system/references/belongs-to.js",
"line": 9,
"description": "A BelongsToReference is a low level API that allows users and\naddon author to perform meta-operations on a belongs-to\nrelationship.",
"extends": "DS.Reference"
},
"DS.RecordReference": {
"name": "DS.RecordReference",
"shortname": "DS.RecordReference",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/-private/system/references/record.js",
"line": 4,
"description": "An RecordReference is a low level API that allows users and\naddon author to perform meta-operations on a record."
},
"DS": {
"name": "DS",
"shortname": "DS",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "",
"file": "addon/-private/core.js",
"line": 8,
"description": "All Ember Data classes, methods and functions are defined inside of this namespace.",
"static": 1
},
"DS.ManyArray": {
"name": "DS.ManyArray",
"shortname": "DS.ManyArray",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/-private/system/many-array.js",
"line": 11,
"description": "A `ManyArray` is a `MutableArray` that represents the contents of a has-many\nrelationship.\n\nThe `ManyArray` is instantiated lazily the first time the relationship is\nrequested.\n\n### Inverses\n\nOften, the relationships in Ember Data applications will have\nan inverse. For example, imagine the following models are\ndefined:\n\n```app/models/post.js\nimport DS from 'ember-data';\n\nexport default DS.Model.extend({\n comments: DS.hasMany('comment')\n});\n```\n\n```app/models/comment.js\nimport DS from 'ember-data';\n\nexport default DS.Model.extend({\n post: DS.belongsTo('post')\n});\n```\n\nIf you created a new instance of `App.Post` and added\na `App.Comment` record to its `comments` has-many\nrelationship, you would expect the comment's `post`\nproperty to be set to the post that contained\nthe has-many.\n\nWe call the record to which a relationship belongs the\nrelationship's _owner_.",
"extends": "Ember.Object",
"uses": [
"Ember.MutableArray",
"Ember.Evented"
]
},
"DS.PromiseArray": {
"name": "DS.PromiseArray",
"shortname": "DS.PromiseArray",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/-private/system/promise-proxies.js",
"line": 6,
"description": "A `PromiseArray` is an object that acts like both an `Ember.Array`\nand a promise. When the promise is resolved the resulting value\nwill be set to the `PromiseArray`'s `content` property. This makes\nit easy to create data bindings with the `PromiseArray` that will be\nupdated when the promise resolves.\n\nFor more information see the [Ember.PromiseProxyMixin\ndocumentation](/api/classes/Ember.PromiseProxyMixin.html).\n\nExample\n\n```javascript\nvar promiseArray = DS.PromiseArray.create({\n promise: $.getJSON('/some/remote/data.json')\n});\n\npromiseArray.get('length'); // 0\n\npromiseArray.then(function() {\n promiseArray.get('length'); // 100\n});\n```",
"extends": "Ember.ArrayProxy",
"uses": [
"Ember.PromiseProxyMixin"
]
},
"DS.PromiseObject": {
"name": "DS.PromiseObject",
"shortname": "DS.PromiseObject",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/-private/system/promise-proxies.js",
"line": 37,
"description": "A `PromiseObject` is an object that acts like both an `Ember.Object`\nand a promise. When the promise is resolved, then the resulting value\nwill be set to the `PromiseObject`'s `content` property. This makes\nit easy to create data bindings with the `PromiseObject` that will\nbe updated when the promise resolves.\n\nFor more information see the [Ember.PromiseProxyMixin\ndocumentation](/api/classes/Ember.PromiseProxyMixin.html).\n\nExample\n\n```javascript\nvar promiseObject = DS.PromiseObject.create({\n promise: $.getJSON('/some/remote/data.json')\n});\n\npromiseObject.get('name'); // null\n\npromiseObject.then(function() {\n promiseObject.get('name'); // 'Tomster'\n});\n```",
"extends": "Ember.ObjectProxy",
"uses": [
"Ember.PromiseProxyMixin"
]
},
"DS.PromiseManyArray": {
"name": "DS.PromiseManyArray",
"shortname": "DS.PromiseManyArray",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/-private/system/promise-proxies.js",
"line": 80,
"description": "A PromiseManyArray is a PromiseArray that also proxies certain method calls\nto the underlying manyArray.\nRight now we proxy:\n\n * `reload()`\n * `createRecord()`\n * `on()`\n * `one()`\n * `trigger()`\n * `off()`\n * `has()`",
"extends": "Ember.ArrayProxy"
},
"DS.RecordArrayManager": {
"name": "DS.RecordArrayManager",
"shortname": "DS.RecordArrayManager",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/-private/system/record-array-manager.js",
"line": 61,
"access": "private",
"tagname": "",
"extends": "Ember.Object"
},
"DS.SnapshotRecordArray": {
"name": "DS.SnapshotRecordArray",
"shortname": "DS.SnapshotRecordArray",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/-private/system/snapshot-record-array.js",
"line": 5,
"access": "private",
"tagname": "",
"is_constructor": 1,
"params": [
{
"name": "snapshots",
"description": "An array of snapshots",
"type": "Array"
},
{
"name": "meta",
"description": "",
"type": "Object"
}
]
},
"DS.Snapshot": {
"name": "DS.Snapshot",
"shortname": "DS.Snapshot",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/-private/system/snapshot.js",
"line": 10,
"access": "private",
"tagname": "",
"is_constructor": 1,
"params": [
{
"name": "internalModel",
"description": "The model to create a snapshot from",
"type": "DS.Model"
}
]
},
"DS.Store": {
"name": "DS.Store",
"shortname": "DS.Store",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/-private/system/store.js",
"line": 133,
"description": "The store contains all of the data for records loaded from the server.\nIt is also responsible for creating instances of `DS.Model` that wrap\nthe individual data for a record, so that they can be bound to in your\nHandlebars templates.\n\nDefine your application's store like this:\n\n```app/services/store.js\nimport DS from 'ember-data';\n\nexport default DS.Store.extend({\n});\n```\n\nMost Ember.js applications will only have a single `DS.Store` that is\nautomatically created by their `Ember.Application`.\n\nYou can retrieve models from the store in several ways. To retrieve a record\nfor a specific id, use `DS.Store`'s `findRecord()` method:\n\n```javascript\nstore.findRecord('person', 123).then(function (person) {\n});\n```\n\nBy default, the store will talk to your backend using a standard\nREST mechanism. You can customize how the store talks to your\nbackend by specifying a custom adapter:\n\n```app/adapters/application.js\nimport DS from 'ember-data';\n\nexport default DS.Adapter.extend({\n});\n```\n\nYou can learn more about writing a custom adapter by reading the `DS.Adapter`\ndocumentation.\n\n### Store createRecord() vs. push() vs. pushPayload()\n\nThe store provides multiple ways to create new record objects. They have\nsome subtle differences in their use which are detailed below:\n\n[createRecord](#method_createRecord) is used for creating new\nrecords on the client side. This will return a new record in the\n`created.uncommitted` state. In order to persist this record to the\nbackend you will need to call `record.save()`.\n\n[push](#method_push) is used to notify Ember Data's store of new or\nupdated records that exist in the backend. This will return a record\nin the `loaded.saved` state. The primary use-case for `store#push` is\nto notify Ember Data about record updates (full or partial) that happen\noutside of the normal adapter methods (for example\n[SSE](http://dev.w3.org/html5/eventsource/) or [Web\nSockets](http://www.w3.org/TR/2009/WD-websockets-20091222/)).\n\n[pushPayload](#method_pushPayload) is a convenience wrapper for\n`store#push` that will deserialize payloads if the\nSerializer implements a `pushPayload` method.\n\nNote: When creating a new record using any of the above methods\nEmber Data will update `DS.RecordArray`s such as those returned by\n`store#peekAll()`, `store#findAll()` or `store#filter()`. This means any\ndata bindings or computed properties that depend on the RecordArray\nwill automatically be synced to include the new or updated record\nvalues.",
"extends": "Ember.Service"
},
"DS.BooleanTransform": {
"name": "DS.BooleanTransform",
"shortname": "DS.BooleanTransform",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/-private/transforms/boolean.js",
"line": 6,
"description": "The `DS.BooleanTransform` class is used to serialize and deserialize\nboolean attributes on Ember Data record objects. This transform is\nused when `boolean` is passed as the type parameter to the\n[DS.attr](../../data#method_attr) function.\n\nUsage\n\n```app/models/user.js\nimport DS from 'ember-data';\n\nexport default DS.Model.extend({\n isAdmin: DS.attr('boolean'),\n name: DS.attr('string'),\n email: DS.attr('string')\n});\n```\n\nBy default the boolean transform only allows for values of `true` or\n`false`. You can opt into allowing `null` values for\nboolean attributes via `DS.attr('boolean', { allowNull: true })`\n\n```app/models/user.js\nimport DS from 'ember-data';\n\nexport default DS.Model.extend({\n email: DS.attr('string'),\n username: DS.attr('string'),\n wantsWeeklyEmail: DS.attr('boolean', { allowNull: true })\n});\n```",
"extends": "DS.Transform"
},
"DS.DateTransform": {
"name": "DS.DateTransform",
"shortname": "DS.DateTransform",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/-private/transforms/date.js",
"line": 3,
"description": "The `DS.DateTransform` class is used to serialize and deserialize\ndate attributes on Ember Data record objects. This transform is used\nwhen `date` is passed as the type parameter to the\n[DS.attr](../../data#method_attr) function. It uses the [`ISO 8601`](https://en.wikipedia.org/wiki/ISO_8601)\nstandard.\n\n```app/models/score.js\nimport DS from 'ember-data';\n\nexport default DS.Model.extend({\n value: DS.attr('number'),\n player: DS.belongsTo('player'),\n date: DS.attr('date')\n});\n```",
"extends": "DS.Transform"
},
"DS.NumberTransform": {
"name": "DS.NumberTransform",
"shortname": "DS.NumberTransform",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/-private/transforms/number.js",
"line": 10,
"description": "The `DS.NumberTransform` class is used to serialize and deserialize\nnumeric attributes on Ember Data record objects. This transform is\nused when `number` is passed as the type parameter to the\n[DS.attr](../../data#method_attr) function.\n\nUsage\n\n```app/models/score.js\nimport DS from 'ember-data';\n\nexport default DS.Model.extend({\n value: DS.attr('number'),\n player: DS.belongsTo('player'),\n date: DS.attr('date')\n});\n```",
"extends": "DS.Transform"
},
"DS.StringTransform": {
"name": "DS.StringTransform",
"shortname": "DS.StringTransform",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/-private/transforms/string.js",
"line": 6,
"description": "The `DS.StringTransform` class is used to serialize and deserialize\nstring attributes on Ember Data record objects. This transform is\nused when `string` is passed as the type parameter to the\n[DS.attr](../../data#method_attr) function.\n\nUsage\n\n```app/models/user.js\nimport DS from 'ember-data';\n\nexport default DS.Model.extend({\n isAdmin: DS.attr('boolean'),\n name: DS.attr('string'),\n email: DS.attr('string')\n});\n```",
"extends": "DS.Transform"
},
"DS.AdapterError": {
"name": "DS.AdapterError",
"shortname": "DS.AdapterError",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/adapters/errors.js",
"line": 11,
"description": "A `DS.AdapterError` is used by an adapter to signal that an error occurred\nduring a request to an external API. It indicates a generic error, and\nsubclasses are used to indicate specific error states. The following\nsubclasses are provided:\n\n- `DS.InvalidError`\n- `DS.TimeoutError`\n- `DS.AbortError`\n- `DS.UnauthorizedError`\n- `DS.ForbiddenError`\n- `DS.NotFoundError`\n- `DS.ConflictError`\n- `DS.ServerError`\n\nTo create a custom error to signal a specific error state in communicating\nwith an external API, extend the `DS.AdapterError`. For example if the\nexternal API exclusively used HTTP `503 Service Unavailable` to indicate\nit was closed for maintenance:\n\n```app/adapters/maintenance-error.js\nimport DS from 'ember-data';\n\nexport default DS.AdapterError.extend({ message: \"Down for maintenance.\" });\n```\n\nThis error would then be returned by an adapter's `handleResponse` method:\n\n```app/adapters/application.js\nimport DS from 'ember-data';\nimport MaintenanceError from './maintenance-error';\n\nexport default DS.JSONAPIAdapter.extend({\n handleResponse(status) {\n if (503 === status) {\n return new MaintenanceError();\n }\n\n return this._super(...arguments);\n }\n});\n```\n\nAnd can then be detected in an application and used to send the user to an\n`under-maintenance` route:\n\n```app/routes/application.js\nimport Ember from 'ember';\nimport MaintenanceError from '../adapters/maintenance-error';\n\nexport default Ember.Route.extend({\n actions: {\n error(error, transition) {\n if (error instanceof MaintenanceError) {\n this.transitionTo('under-maintenance');\n return;\n }\n\n // ...other error handling logic\n }\n }\n});\n```"
},
"DS.InvalidError": {
"name": "DS.InvalidError",
"shortname": "DS.InvalidError",
"classitems": [],
"plugins": [],
"extensions": [],
"plugin_for": [],
"extension_for": [],
"module": "ember-data",
"namespace": "DS",
"file": "addon/adapters/errors.js",
"line": 121,
"description": "A `DS.InvalidError` is used by an adapter to signal the external API\nwas unable to process a request because the content was not\nsemantically correct or meaningful per the API. Usually this means a\nrecord failed some form of server side validation. When a promise\nfrom an adapter is rejected with a `DS.InvalidError` the record will\ntransition to the `invalid` state and the errors will be set to the\n`errors` property on the record.\n\nFor Ember Data to correctly map errors to their corresponding\nproperties on the model, Ember Data expects each error to be\na valid json-api error object with a `source/pointer` that matches\nthe property name. For example if you had a Post model that\nlooked like this.\n\n```app/models/post.js\nimport DS from 'ember-data';\n\nexport default DS.Model.extend({\n title: DS.attr('string'),\n content: DS.attr('string')\n});\n```\n\nTo show an error from the server related to the `title` and\n`content` properties your adapter could return a promise that\nrejects with a `DS.InvalidError` object that looks like this:\n\n```app/adapters/post.js\nimport Ember from 'ember';\nimport DS from 'ember-data';\n\nexport default DS.RESTAdapter.extend({\n updateRecord: function() {\n // Fictional adapter that always rejects\n return Ember.RSVP.reject(new DS.InvalidError([\n {\n detail: 'Must be unique',\n source: { pointer: '/data/attributes/title' }\n },\n {\n detail: 'Must not be blank',\n source: { pointer: '/data/attributes/content'}\n }\n ]));\n }\n});\n```\n\nYour backend may use different property names for your records the\nstore will attempt extract and normalize the errors using the\nserializer's `extractErrors` method before the errors get added to\nthe the model. As a result, it is safe for the `InvalidError` to\nwrap the error payload unaltered."