graphiti 2.0.0.beta.7 → 2.0.0.beta.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (238) hide show
  1. checksums.yaml +4 -4
  2. data/.git-blame-ignore-revs +2 -0
  3. data/.github/workflows/ci.yml +55 -3
  4. data/.github/workflows/docs.yml +1 -1
  5. data/.github/workflows/notify-example-app.yml +18 -0
  6. data/.gitignore +2 -0
  7. data/.standard.yml +6 -0
  8. data/CHANGELOG.md +45 -0
  9. data/CONTRIBUTING.md +3 -1
  10. data/README.md +13 -206
  11. data/Rakefile +6 -3
  12. data/UPGRADING.md +1 -1
  13. data/graphiti.gemspec +8 -4
  14. data/lib/generators/graphiti/generator_mixin.rb +1 -1
  15. data/lib/generators/graphiti/install_generator.rb +1 -1
  16. data/lib/generators/graphiti/resource_generator.rb +6 -3
  17. data/lib/generators/graphiti/templates/application_resource.rb.erb +19 -0
  18. data/lib/generators/graphiti/templates/controller.rb.erb +26 -8
  19. data/lib/graphiti/audit/report.rb +6 -6
  20. data/lib/graphiti/audit.rb +3 -4
  21. data/lib/graphiti/delegates/pagination.rb +2 -2
  22. data/lib/graphiti/deserializer.rb +3 -3
  23. data/lib/graphiti/errors.rb +6 -6
  24. data/lib/graphiti/extensions/temp_id.rb +1 -1
  25. data/lib/graphiti/query.rb +3 -3
  26. data/lib/graphiti/rails/context.rb +2 -1
  27. data/lib/graphiti/rails/controller.rb +3 -0
  28. data/lib/graphiti/rails/debugging.rb +1 -1
  29. data/lib/graphiti/rails/responders.rb +2 -1
  30. data/lib/graphiti/resource/configuration.rb +1 -0
  31. data/lib/graphiti/resource/dsl.rb +2 -2
  32. data/lib/graphiti/resource/links.rb +1 -1
  33. data/lib/graphiti/resource/persistence.rb +1 -1
  34. data/lib/graphiti/resource/polymorphism.rb +1 -1
  35. data/lib/graphiti/resource.rb +2 -2
  36. data/lib/graphiti/resource_proxy.rb +0 -1
  37. data/lib/graphiti/scoping/filter.rb +5 -3
  38. data/lib/graphiti/scoping/paginate.rb +1 -1
  39. data/lib/graphiti/scoping/sort.rb +1 -1
  40. data/lib/graphiti/sideload/has_many.rb +1 -1
  41. data/lib/graphiti/spec_helpers/errors_proxy.rb +1 -1
  42. data/lib/graphiti/spec_helpers/matchers.rb +1 -1
  43. data/lib/graphiti/types.rb +5 -1
  44. data/lib/graphiti/util/cache_debug.rb +3 -3
  45. data/lib/graphiti/util/hash.rb +1 -1
  46. data/lib/graphiti/util/persistence.rb +6 -6
  47. data/lib/graphiti/util/serializer_relationships.rb +1 -1
  48. data/lib/graphiti/version.rb +1 -1
  49. data/lib/tasks/graphiti.rake +1 -1
  50. metadata +31 -197
  51. data/docs/concepts/backends-and-models.md +0 -122
  52. data/docs/concepts/endpoints.md +0 -183
  53. data/docs/concepts/links.md +0 -212
  54. data/docs/concepts/overview.md +0 -80
  55. data/docs/concepts/persisting.md +0 -376
  56. data/docs/concepts/relationships.md +0 -627
  57. data/docs/concepts/resources.md +0 -677
  58. data/docs/getting-started/first-api.md +0 -289
  59. data/docs/getting-started/installation.md +0 -185
  60. data/docs/intro.md +0 -307
  61. data/docs/js/authentication.md +0 -63
  62. data/docs/js/ddau.md +0 -20
  63. data/docs/js/extra-params.md +0 -41
  64. data/docs/js/index.md +0 -112
  65. data/docs/js/installation.md +0 -120
  66. data/docs/js/middleware.md +0 -72
  67. data/docs/js/models.md +0 -202
  68. data/docs/js/reads.md +0 -494
  69. data/docs/js/state-syncing.md +0 -100
  70. data/docs/js/writes.md +0 -373
  71. data/docs/reference/vandal.md +0 -63
  72. data/docs/reference/why.md +0 -13
  73. data/docs/topics/authorization.md +0 -155
  74. data/docs/topics/caching.md +0 -55
  75. data/docs/topics/customizing-sideloads.md +0 -156
  76. data/docs/topics/debugging.md +0 -242
  77. data/docs/topics/error-handling.md +0 -210
  78. data/docs/topics/etags.md +0 -46
  79. data/docs/topics/hopping-relationships.md +0 -149
  80. data/docs/topics/json-attributes.md +0 -77
  81. data/docs/topics/openstruct-models.md +0 -50
  82. data/docs/topics/remote-resources.md +0 -291
  83. data/docs/topics/testing.md +0 -916
  84. data/docs/topics/without-activerecord.md +0 -324
  85. data/docs/tutorial/index.md +0 -58
  86. data/docs/tutorial/step_0.md +0 -107
  87. data/docs/tutorial/step_1.md +0 -199
  88. data/docs/tutorial/step_2.md +0 -312
  89. data/docs/tutorial/step_3.md +0 -142
  90. data/docs/tutorial/step_4.md +0 -135
  91. data/docs/tutorial/step_5.md +0 -69
  92. data/docs/tutorial/step_6.md +0 -82
  93. data/docs/tutorial/step_7.md +0 -205
  94. data/docs/tutorial/step_8.md +0 -128
  95. data/docs/tutorial/step_9.md +0 -171
  96. data/docs/upgrading.md +0 -267
  97. data/website/.gitignore +0 -20
  98. data/website/README.md +0 -43
  99. data/website/docusaurus.config.js +0 -197
  100. data/website/package-lock.json +0 -19474
  101. data/website/package.json +0 -46
  102. data/website/sidebars.js +0 -82
  103. data/website/src/css/custom.css +0 -85
  104. data/website/src/pages/markdown-page.mdx +0 -7
  105. data/website/static/.nojekyll +0 -0
  106. data/website/static/1.13/2019/03/31/graphiti-1-0.html +0 -205
  107. data/website/static/1.13/2019/05/08/graphiti-1-1.html +0 -212
  108. data/website/static/1.13/2019/05/20/graphiti-1-2.html +0 -214
  109. data/website/static/1.13/2019/10/14/tutorial.html +0 -198
  110. data/website/static/1.13/CNAME +0 -1
  111. data/website/static/1.13/README.md +0 -16
  112. data/website/static/1.13/assets/css/syntax.css +0 -60
  113. data/website/static/1.13/assets/favicons/android-chrome-192x192.png +0 -0
  114. data/website/static/1.13/assets/favicons/android-chrome-256x256.png +0 -0
  115. data/website/static/1.13/assets/favicons/apple-touch-icon.png +0 -0
  116. data/website/static/1.13/assets/favicons/browserconfig.xml +0 -9
  117. data/website/static/1.13/assets/favicons/favicon-16x16.png +0 -0
  118. data/website/static/1.13/assets/favicons/favicon-32x32.png +0 -0
  119. data/website/static/1.13/assets/favicons/favicon.ico +0 -0
  120. data/website/static/1.13/assets/favicons/mstile-150x150.png +0 -0
  121. data/website/static/1.13/assets/favicons/safari-pinned-tab.svg +0 -1
  122. data/website/static/1.13/assets/favicons/site.webmanifest +0 -19
  123. data/website/static/1.13/assets/img/backend.gif +0 -0
  124. data/website/static/1.13/assets/img/conformity.png +0 -0
  125. data/website/static/1.13/assets/img/error_payload.png +0 -0
  126. data/website/static/1.13/assets/img/fancy-cushion.png +0 -0
  127. data/website/static/1.13/assets/img/gh.png +0 -0
  128. data/website/static/1.13/assets/img/home-bg.jpg +0 -0
  129. data/website/static/1.13/assets/img/lifecycle.gif +0 -0
  130. data/website/static/1.13/assets/img/logo-500.png +0 -0
  131. data/website/static/1.13/assets/img/logo.png +0 -0
  132. data/website/static/1.13/assets/img/love-graffiti.jpg +0 -0
  133. data/website/static/1.13/assets/img/meta_total_count.png +0 -0
  134. data/website/static/1.13/assets/img/persist.jpg +0 -0
  135. data/website/static/1.13/assets/img/resource.gif +0 -0
  136. data/website/static/1.13/assets/img/rest-graffiti.jpg +0 -0
  137. data/website/static/1.13/assets/img/rest1.gif +0 -0
  138. data/website/static/1.13/assets/img/rest2.gif +0 -0
  139. data/website/static/1.13/assets/img/rest3.gif +0 -0
  140. data/website/static/1.13/assets/img/rethink-rest-graffiti.jpg +0 -0
  141. data/website/static/1.13/assets/img/sunrise.png +0 -0
  142. data/website/static/1.13/assets/img/why.png +0 -0
  143. data/website/static/1.13/assets/js/highlight.pack.js +0 -2
  144. data/website/static/1.13/assets/main.css +0 -15518
  145. data/website/static/1.13/assets/main.css.map +0 -1
  146. data/website/static/1.13/bin/bundle +0 -109
  147. data/website/static/1.13/bin/jekyll +0 -27
  148. data/website/static/1.13/bin/kramdown +0 -27
  149. data/website/static/1.13/bin/listen +0 -27
  150. data/website/static/1.13/bin/rake +0 -27
  151. data/website/static/1.13/bin/rougify +0 -27
  152. data/website/static/1.13/bin/safe_yaml +0 -27
  153. data/website/static/1.13/bin/sass +0 -27
  154. data/website/static/1.13/bin/sass-convert +0 -27
  155. data/website/static/1.13/bin/scss +0 -27
  156. data/website/static/1.13/blog.html +0 -259
  157. data/website/static/1.13/cheatsheet.html +0 -316
  158. data/website/static/1.13/cookbooks/authorization.md +0 -0
  159. data/website/static/1.13/cookbooks/caching.md +0 -0
  160. data/website/static/1.13/cookbooks/customizing-sideloads.html +0 -325
  161. data/website/static/1.13/cookbooks/etags.md +0 -0
  162. data/website/static/1.13/cookbooks/hopping-relationships.html +0 -324
  163. data/website/static/1.13/cookbooks/json_attributes.md +0 -0
  164. data/website/static/1.13/cookbooks/openstruct-models.md +0 -0
  165. data/website/static/1.13/cookbooks/remote-resources.md +0 -0
  166. data/website/static/1.13/cookbooks/without-activerecord.html +0 -510
  167. data/website/static/1.13/features.html +0 -249
  168. data/website/static/1.13/feed.xml +0 -106
  169. data/website/static/1.13/guides/concepts/backends-and-models.html +0 -467
  170. data/website/static/1.13/guides/concepts/debugging.html +0 -440
  171. data/website/static/1.13/guides/concepts/endpoints.html +0 -432
  172. data/website/static/1.13/guides/concepts/error-handling.html +0 -396
  173. data/website/static/1.13/guides/concepts/links.html +0 -501
  174. data/website/static/1.13/guides/concepts/remote-resources.html +0 -536
  175. data/website/static/1.13/guides/concepts/resources.html +0 -2176
  176. data/website/static/1.13/guides/concepts/testing.html +0 -1469
  177. data/website/static/1.13/guides/getting-started/installation.html +0 -420
  178. data/website/static/1.13/guides/graphiti-rails-migration.html +0 -242
  179. data/website/static/1.13/guides/index.html +0 -269
  180. data/website/static/1.13/guides/overview.html +0 -325
  181. data/website/static/1.13/guides/upgrading-2-0.html +0 -193
  182. data/website/static/1.13/guides/upgrading.html +0 -314
  183. data/website/static/1.13/guides/vandal.html +0 -282
  184. data/website/static/1.13/guides/why.html +0 -1121
  185. data/website/static/1.13/index.html +0 -72
  186. data/website/static/1.13/js/authentication.html +0 -295
  187. data/website/static/1.13/js/ddau.html +0 -238
  188. data/website/static/1.13/js/extra-params.html +0 -270
  189. data/website/static/1.13/js/index.html +0 -321
  190. data/website/static/1.13/js/installation.html +0 -637
  191. data/website/static/1.13/js/introduction.html +0 -257
  192. data/website/static/1.13/js/middleware.html +0 -318
  193. data/website/static/1.13/js/reads/fieldsets.html +0 -271
  194. data/website/static/1.13/js/reads/filtering.html +0 -289
  195. data/website/static/1.13/js/reads/includes.html +0 -260
  196. data/website/static/1.13/js/reads/index.html +0 -497
  197. data/website/static/1.13/js/reads/nested-queries.html +0 -353
  198. data/website/static/1.13/js/reads/pagination.html +0 -260
  199. data/website/static/1.13/js/reads/sorting.html +0 -265
  200. data/website/static/1.13/js/reads/statistics.html +0 -289
  201. data/website/static/1.13/js/state-syncing.html +0 -340
  202. data/website/static/1.13/js/writes/deferred.html +0 -296
  203. data/website/static/1.13/js/writes/dirty-tracking.html +0 -399
  204. data/website/static/1.13/js/writes/index.html +0 -391
  205. data/website/static/1.13/js/writes/nested.html +0 -330
  206. data/website/static/1.13/js/writes/validations.html +0 -272
  207. data/website/static/1.13/quickstart.html +0 -660
  208. data/website/static/1.13/template +0 -161
  209. data/website/static/1.13/tutorial/index.html +0 -250
  210. data/website/static/1.13/tutorial/step_0.html +0 -292
  211. data/website/static/1.13/tutorial/step_1.html +0 -517
  212. data/website/static/1.13/tutorial/step_2.html +0 -481
  213. data/website/static/1.13/tutorial/step_3.html +0 -323
  214. data/website/static/1.13/tutorial/step_4.html +0 -318
  215. data/website/static/1.13/tutorial/step_5.html +0 -265
  216. data/website/static/1.13/tutorial/step_6.html +0 -276
  217. data/website/static/1.13/tutorial/step_7.html +0 -390
  218. data/website/static/1.13/tutorial/step_8.html +0 -316
  219. data/website/static/1.13/tutorial/step_9.html +0 -365
  220. data/website/static/CNAME +0 -1
  221. data/website/static/assets/img/error_payload.png +0 -0
  222. data/website/static/assets/img/legacy/legacy-0378a3bb39.png +0 -0
  223. data/website/static/assets/img/legacy/legacy-05bbd3e5fd.png +0 -0
  224. data/website/static/assets/img/legacy/legacy-07aa104495.png +0 -0
  225. data/website/static/assets/img/legacy/legacy-0c75a16b3a.gif +0 -0
  226. data/website/static/assets/img/legacy/legacy-3076df6209.png +0 -0
  227. data/website/static/assets/img/legacy/legacy-7f6889bc89.png +0 -0
  228. data/website/static/assets/img/legacy/legacy-a2cc4363c3.png +0 -0
  229. data/website/static/assets/img/legacy/legacy-f67cfa89ab.png +0 -0
  230. data/website/static/assets/img/meta_total_count.png +0 -0
  231. data/website/static/img/docusaurus-social-card.jpg +0 -0
  232. data/website/static/img/docusaurus.png +0 -0
  233. data/website/static/img/favicon.ico +0 -0
  234. data/website/static/img/logo.png +0 -0
  235. data/website/static/img/logo.svg +0 -1
  236. data/website/static/img/undraw_docusaurus_mountain.svg +0 -171
  237. data/website/static/img/undraw_docusaurus_react.svg +0 -170
  238. data/website/static/img/undraw_docusaurus_tree.svg +0 -40
data/website/static/1.13/js/installation.html DELETED
@@ -1,637 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
-
4
- <head>
5
- <meta charset="utf-8">
6
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
7
- <meta name="viewport" content="width=device-width, initial-scale=1">
8
- <link href="https://fonts.googleapis.com/css?family=Roboto+Mono" rel="stylesheet">
9
- <link href="https://fonts.googleapis.com/css?family=Boogaloo" rel="stylesheet">
10
-
11
- <link rel="apple-touch-icon" sizes="180x180" href="/1.13/assets/favicons/apple-touch-icon.png">
12
- <link rel="icon" type="image/png" sizes="32x32" href="/1.13/assets/favicons/favicon-32x32.png">
13
- <link rel="icon" type="image/png" sizes="16x16" href="/1.13/assets/favicons/favicon-16x16.png">
14
- <link rel="manifest" href="/1.13/assets/favicons/site.webmanifest">
15
- <link rel="mask-icon" href="/1.13/assets/favicons/safari-pinned-tab.svg" color="#F86DA7">
16
- <link rel="shortcut icon" href="/1.13/assets/favicons/favicon.ico">
17
- <meta name="msapplication-TileColor" content="#F86DA7">
18
- <meta name="msapplication-config" content="/1.13/assets/favicons/browserconfig.xml">
19
- <meta name="theme-color" content="#F86DA7">
20
-
21
- <title>Graphiti</title>
22
- <meta name="description" content="Stylish Graph APIs">
23
-
24
- <link rel="stylesheet" href="/1.13/assets/main.css?ref=wh4t3v45">
25
- <link rel="alternate" type="application/rss+xml" title="Graphiti" href="/1.13/feed.xml">
26
-
27
- <!-- Global site tag (gtag.js) - Google Analytics -->
28
- <script async src="https://www.googletagmanager.com/gtag/js?id=UA-127904727-1"></script>
29
- <script>
30
- window.dataLayer = window.dataLayer || [];
31
- function gtag(){dataLayer.push(arguments);}
32
- gtag('js', new Date());
33
-
34
- gtag('config', 'UA-127904727-1');
35
- </script>
36
-
37
- <!-- javascript -->
38
- <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
39
- <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
40
-
41
-
42
- </head>
43
-
44
-
45
- <body>
46
- <main class="page-content" aria-label="Content">
47
- <div class="wrapper">
48
- <header class="navbar navbar-inverse normal" role="banner">
49
- <div class="container">
50
- <div class="navbar-header">
51
- <a href="/1.13/1.13" class="navbar-brand">
52
- <img alt="logo" src="/1.13/assets/img/logo.png">
53
- </a>
54
- </div>
55
- <nav class="" role="navigation">
56
- <ul class="nav navbar-nav nav-links">
57
- <li>
58
- <a class="quickstart nav-link" href="/1.13/quickstart">Quickstart</a>
59
- </li>
60
- <li>
61
- <a class="guides nav-link" href="/1.13/guides">Guides</a>
62
- </li>
63
- <li>
64
- <a class="tutorial nav-link" href="/1.13/tutorial">Tutorial</a>
65
- </li>
66
- <li>
67
- <a class="spraypaint nav-link" href="/1.13/js">Spraypaint</a>
68
- </li>
69
- </ul>
70
- <ul class="nav gh navbar-nav navbar-right visible-lg visible-md">
71
- <li>
72
- <span class="star">⭐</span>
73
- <a href="https://github.com/graphiti-api/graphiti">
74
- <img alt="github-star" style="margin-right: 65px;margin-top: -20px" src="/1.13/assets/img/gh.png">
75
- </a>
76
- </li>
77
- </ul>
78
- </nav>
79
- </div>
80
- </header>
81
-
82
- <div class="container">
83
- <h1>
84
- Spraypaint
85
- <small>the isomorphic, framework-agnostic Graphiti ORM</small>
86
- </h1>
87
-
88
- <div class="js-toc col-md-3">
89
- <ul>
90
- <li><a href="/1.13/js/index">Home</a></li>
91
- <li><a href="/1.13/js/introduction">Introduction</a></li>
92
- <li><a href="/1.13/js/installation">Installation</a>
93
- <ul>
94
- <li><a href="/1.13/js/installation#typescript">Typescript</a></li>
95
- <li><a href="/1.13/js/installation#defining-models">Defining Models</a></li>
96
- <li><a href="/1.13/js/installation#connecting-to-the-api">Connecting to the API</a></li>
97
- <li><a href="/1.13/js/installation#defining-attributes">Defining Attributes</a></li>
98
- <li><a href="/1.13/js/installation#defining-relationships">Defining Relationships</a></li>
99
- </ul>
100
- </li>
101
- <li><a href="/1.13/js/reads">Reads</a>
102
- <ul>
103
- <li><a href="/1.13/js/reads/sorting">Sorting</a></li>
104
- <li><a href="/1.13/js/reads/pagination">Pagination</a></li>
105
- <li><a href="/1.13/js/reads/filtering">Filtering</a></li>
106
- <li><a href="/1.13/js/reads/fieldsets">Fieldsets</a></li>
107
- <li><a href="/1.13/js/reads/statistics">Statistics</a></li>
108
- <li><a href="/1.13/js/reads/includes">Includes</a></li>
109
- <li><a href="/1.13/js/reads/nested-queries">Nested Queries</a></li>
110
- </ul>
111
- </li>
112
- <li><a href="/1.13/js/writes">Writes</a>
113
- <ul>
114
- <li><a href="/1.13/js/writes/validations">Validations</a></li>
115
- <li><a href="/1.13/js/writes/dirty-tracking">Dirty Tracking</a></li>
116
- <li><a href="/1.13/js/writes/nested">Nested Writes</a></li>
117
- <li><a href="/1.13/js/writes/deferred">Deferred Action</a></li>
118
- </ul>
119
- </li>
120
- <li><a href="/1.13/js/middleware">Middleware</a></li>
121
- <li><a href="/1.13/js/authentication">Authentication</a></li>
122
- <li><a href="/1.13/js/state-syncing">State Syncing</a></li>
123
- <li><a href="/1.13/js/ddau">Data Down, Actions Up</a></li>
124
- <li><a href="/1.13/js/extra-params">Extra params</a></li>
125
- </ul>
126
- </div>
127
-
128
- <div class="col-md-8 col-md-offset-1">
129
- <h3 id="installation">Installation</h3>
130
-
131
- <p>Installation is straightforward. Since we use <code class="language-plaintext highlighter-rouge">fetch</code> underneath the
132
- hood, we recommend installing alongside a <code class="language-plaintext highlighter-rouge">fetch</code> polyfill.</p>
133
-
134
- <p>If using <code class="language-plaintext highlighter-rouge">yarn</code>:</p>
135
-
136
- <figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>yarn add spraypaint isomorphic-fetch</code></pre></figure>
137
-
138
- <p>If using <code class="language-plaintext highlighter-rouge">npm</code>:</p>
139
-
140
- <figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>npm <span class="nb">install </span>spraypaint isomorphic-fetch</code></pre></figure>
141
-
142
- <p>Now import it:</p>
143
-
144
- <div class="tabs">
145
- <div class="tab typescript active">
146
- <span>Typescript</span>
147
- </div>
148
- <div class="tab javascript">
149
- <span>Javascript</span>
150
- </div>
151
- </div>
152
-
153
- <div class="code-tabs">
154
-
155
- <figure class="highlight"><pre><code class="language-typescript" data-lang="typescript"><span class="k">import</span> <span class="p">{</span>
156
- <span class="nx">Model</span><span class="p">,</span>
157
- <span class="nx">SpraypaintBase</span><span class="p">,</span>
158
- <span class="nx">Attr</span><span class="p">,</span>
159
- <span class="nx">BelongsTo</span><span class="p">,</span>
160
- <span class="nx">HasMany</span>
161
- <span class="c1">// etc</span>
162
- <span class="p">}</span> <span class="k">from</span> <span class="dl">"</span><span class="s2">spraypaint</span><span class="dl">"</span></code></pre></figure>
163
-
164
- <figure class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="kd">const</span> <span class="p">{</span>
165
- <span class="nx">SpraypaintBase</span><span class="p">,</span>
166
- <span class="nx">attr</span><span class="p">,</span>
167
- <span class="nx">belongsTo</span><span class="p">,</span>
168
- <span class="nx">hasMany</span>
169
- <span class="c1">// etc</span>
170
- <span class="p">}</span> <span class="o">=</span> <span class="nf">require</span><span class="p">(</span><span class="dl">"</span><span class="s2">spraypaint/dist/spraypaint</span><span class="dl">"</span><span class="p">)</span></code></pre></figure>
171
-
172
- </div>
173
-
174
- <p>…or, if you’re avoiding JS modules, <code class="language-plaintext highlighter-rouge">spraypaint</code> will be available as a global in
175
- the browser.</p>
176
-
177
- <h3 id="typescript">Typescript</h3>
178
-
179
- <p>Spraypaint supports Typescript versions <code class="language-plaintext highlighter-rouge">&gt;= 2.8</code>.</p>
180
-
181
- <p>By default you will need a <code class="language-plaintext highlighter-rouge">!</code> after each attribute and relationship:</p>
182
-
183
- <figure class="highlight"><pre><code class="language-typescript" data-lang="typescript"><span class="p">@</span><span class="nd">Attr</span> <span class="nx">first_name</span><span class="o">!</span><span class="p">:</span> <span class="kr">string</span>
184
- <span class="p">@</span><span class="nd">HasMany</span><span class="p">()</span> <span class="nx">positions</span><span class="o">!</span><span class="p">:</span> <span class="nx">Position</span><span class="p">[]</span></code></pre></figure>
185
-
186
- <p>This is due to <a href="https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-7.html#strict-class-initialization">Strict Class Initialization</a>. For the purposes of Spraypaint, we don’t need this. Remove the need for
187
- <code class="language-plaintext highlighter-rouge">!</code> (as the rest of these guides do) by setting</p>
188
-
189
- <p><code class="language-plaintext highlighter-rouge">"strictPropertyInitialization": false</code></p>
190
-
191
- <p>in <code class="language-plaintext highlighter-rouge">tsconfig.json</code>.</p>
192
-
193
- <h3 id="defining-models">Defining Models</h3>
194
-
195
- <h4 id="connecting-to-the-api">Connecting to the API</h4>
196
-
197
- <p>Just like <code class="language-plaintext highlighter-rouge">ActiveRecord</code>, our models will inherit from a base class that
198
- holds connection information (<code class="language-plaintext highlighter-rouge">ApplicationRecord</code>, or
199
- <code class="language-plaintext highlighter-rouge">ActiveRecord::Base</code> in Rails &lt; 5):</p>
200
-
201
- <div class="tabs">
202
- <div class="tab typescript active">
203
- <span>Typescript</span>
204
- </div>
205
- <div class="tab javascript">
206
- <span>Javascript</span>
207
- </div>
208
- </div>
209
-
210
- <div class="code-tabs">
211
-
212
- <figure class="highlight"><pre><code class="language-typescript" data-lang="typescript"><span class="p">@</span><span class="nd">Model</span><span class="p">()</span>
213
- <span class="kd">class</span> <span class="nc">ApplicationRecord</span> <span class="kd">extends</span> <span class="nc">SpraypaintBase</span> <span class="p">{</span>
214
- <span class="k">static</span> <span class="nx">baseUrl</span> <span class="o">=</span> <span class="dl">"</span><span class="s2">http://my-api.com</span><span class="dl">"</span>
215
- <span class="k">static</span> <span class="nx">apiNamespace</span> <span class="o">=</span> <span class="dl">"</span><span class="s2">/api/v1</span><span class="dl">"</span>
216
- <span class="p">}</span></code></pre></figure>
217
-
218
- <figure class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="kd">const</span> <span class="nx">ApplicationRecord</span> <span class="o">=</span> <span class="nx">SpraypaintBase</span><span class="p">.</span><span class="nf">extend</span><span class="p">({</span>
219
- <span class="na">static</span><span class="p">:</span> <span class="p">{</span>
220
- <span class="na">baseUrl</span><span class="p">:</span> <span class="dl">"</span><span class="s2">http://my-api.com</span><span class="dl">"</span><span class="p">,</span>
221
- <span class="na">apiNamespace</span><span class="p">:</span> <span class="dl">"</span><span class="s2">/api/v1</span><span class="dl">"</span>
222
- <span class="p">}</span>
223
- <span class="p">})</span></code></pre></figure>
224
-
225
- <p>All URLs follow the following pattern:</p>
226
-
227
- <ul>
228
- <li><code class="language-plaintext highlighter-rouge">baseUrl</code> + <code class="language-plaintext highlighter-rouge">apiNamespace</code> + <code class="language-plaintext highlighter-rouge">jsonapiType</code></li>
229
- </ul>
230
-
231
- <p>As you can see above, typically <code class="language-plaintext highlighter-rouge">baseUrl</code> and <code class="language-plaintext highlighter-rouge">apiNamespace</code> are set on
232
- a top-level <code class="language-plaintext highlighter-rouge">ApplicationRecord</code> (though any subclass can override).
233
- <code class="language-plaintext highlighter-rouge">jsonapiType</code>, however, is set per-model:</p>
234
-
235
- <div class="tabs">
236
- <div class="tab typescript active">
237
- <span>Typescript</span>
238
- </div>
239
- <div class="tab javascript">
240
- <span>Javascript</span>
241
- </div>
242
- </div>
243
-
244
- <div class="code-tabs">
245
-
246
- <figure class="highlight"><pre><code class="language-typescript" data-lang="typescript"><span class="p">@</span><span class="nd">Model</span><span class="p">()</span>
247
- <span class="kd">class</span> <span class="nc">Person</span> <span class="kd">extends</span> <span class="nc">ApplicationRecord</span> <span class="p">{</span>
248
- <span class="k">static</span> <span class="nx">jsonapiType</span> <span class="o">=</span> <span class="dl">"</span><span class="s2">people</span><span class="dl">"</span>
249
- <span class="p">}</span></code></pre></figure>
250
-
251
- <figure class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="kd">const</span> <span class="nx">Person</span> <span class="o">=</span> <span class="nx">ApplicationRecord</span><span class="p">.</span><span class="nf">extend</span><span class="p">({</span>
252
- <span class="na">static</span><span class="p">:</span> <span class="p">{</span>
253
- <span class="na">jsonapiType</span><span class="p">:</span> <span class="dl">"</span><span class="s2">people</span><span class="dl">"</span>
254
- <span class="p">}</span>
255
- <span class="p">})</span></code></pre></figure>
256
-
257
- </div>
258
-
259
- <p>With the above configuration, all <code class="language-plaintext highlighter-rouge">Person</code> endpoints will begin
260
- <code class="language-plaintext highlighter-rouge">http://my-api.com/api/v1/people</code>.</p>
261
-
262
- <blockquote>
263
- <p><strong>TIP</strong>: Avoid CORS and use relative paths by simply setting <code class="language-plaintext highlighter-rouge">baseUrl</code> to
264
- <code class="language-plaintext highlighter-rouge">""</code></p>
265
- </blockquote>
266
-
267
- <blockquote>
268
- <p><strong>TIP</strong>: You can always use the <code class="language-plaintext highlighter-rouge">endpoint</code> option to override this pattern
269
- and set the endpoint manually.</p>
270
- </blockquote>
271
-
272
- <h5 id="setting-application-name">Setting Application Name</h5>
273
-
274
- <p>It can be helpful to send the name of your client application in request
275
- headers. With this information, servers can keep track of which clients
276
- are hitting which APIs.</p>
277
-
278
- <p>To do this:</p>
279
-
280
- <div class="tabs">
281
- <div class="tab typescript active">
282
- <span>Typescript</span>
283
- </div>
284
- <div class="tab javascript">
285
- <span>Javascript</span>
286
- </div>
287
- </div>
288
-
289
- <div class="code-tabs">
290
-
291
- <figure class="highlight"><pre><code class="language-typescript" data-lang="typescript"><span class="p">@</span><span class="nd">Model</span><span class="p">()</span>
292
- <span class="kd">class</span> <span class="nc">Person</span> <span class="kd">extends</span> <span class="nc">ApplicationRecord</span> <span class="p">{</span>
293
- <span class="k">static</span> <span class="nx">clientApplication</span> <span class="o">=</span> <span class="dl">"</span><span class="s2">sales-backend</span><span class="dl">"</span>
294
- <span class="p">}</span></code></pre></figure>
295
-
296
- <figure class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="kd">const</span> <span class="nx">Person</span> <span class="o">=</span> <span class="nx">ApplicationRecord</span><span class="p">.</span><span class="nf">extend</span><span class="p">({</span>
297
- <span class="na">static</span><span class="p">:</span> <span class="p">{</span>
298
- <span class="na">clientApplication</span><span class="p">:</span> <span class="dl">"</span><span class="s2">sales-backend</span><span class="dl">"</span>
299
- <span class="p">}</span>
300
- <span class="p">})</span></code></pre></figure>
301
-
302
- </div>
303
-
304
- <h4 id="defining-attributes">Defining Attributes</h4>
305
-
306
- <p><code class="language-plaintext highlighter-rouge">ActiveRecord</code> automatically sets attributes by introspecting database
307
- columns. We could do the same - <code class="language-plaintext highlighter-rouge">swagger.json</code> is our schema - but tend
308
- to agree with those who feel this aspect of <code class="language-plaintext highlighter-rouge">ActiveRecord</code> is a bit too
309
- “magical”. In addition, explicitly defining our attributes can be used
310
- to track which applications are using which attributes of the API.</p>
311
-
312
- <p>Though this is configurable, by default we expect the API to be
313
- <code class="language-plaintext highlighter-rouge">under_scored</code> and attributes to be <code class="language-plaintext highlighter-rouge">camelCased</code>.</p>
314
-
315
- <div class="tabs">
316
- <div class="tab typescript active">
317
- <span>Typescript</span>
318
- </div>
319
- <div class="tab javascript">
320
- <span>Javascript</span>
321
- </div>
322
- </div>
323
-
324
- <div class="code-tabs">
325
-
326
- <figure class="highlight"><pre><code class="language-typescript" data-lang="typescript"><span class="p">@</span><span class="nd">Model</span><span class="p">()</span>
327
- <span class="kd">class</span> <span class="nc">Person</span> <span class="kd">extends</span> <span class="nc">ApplicationRecord</span> <span class="p">{</span>
328
- <span class="c1">// ... code ...</span>
329
- <span class="p">@</span><span class="nd">Attr</span><span class="p">()</span> <span class="nx">firstName</span><span class="p">:</span> <span class="kr">string</span>
330
- <span class="p">@</span><span class="nd">Attr</span><span class="p">()</span> <span class="nx">lastName</span><span class="p">:</span> <span class="kr">string</span>
331
- <span class="p">@</span><span class="nd">Attr</span><span class="p">()</span> <span class="nx">age</span><span class="p">:</span> <span class="kr">number</span>
332
-
333
- <span class="kd">get</span> <span class="nf">fullName</span><span class="p">()</span> <span class="p">:</span> <span class="kr">string</span> <span class="p">{</span>
334
- <span class="k">return</span> <span class="s2">`</span><span class="p">${</span><span class="k">this</span><span class="p">.</span><span class="nx">firstName</span><span class="p">}</span><span class="s2"> </span><span class="p">${</span><span class="k">this</span><span class="p">.</span><span class="nx">lastName</span><span class="p">}</span><span class="s2">`</span>
335
- <span class="p">}</span>
336
- <span class="p">}</span>
337
-
338
- <span class="kd">let</span> <span class="nx">person</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Person</span><span class="p">({</span> <span class="na">firstName</span><span class="p">:</span> <span class="dl">"</span><span class="s2">John</span><span class="dl">"</span> <span class="p">})</span>
339
- <span class="nx">person</span><span class="p">.</span><span class="nx">firstName</span> <span class="c1">// "John"</span>
340
- <span class="nx">person</span><span class="p">.</span><span class="nx">lastName</span> <span class="o">=</span> <span class="dl">"</span><span class="s2">Doe</span><span class="dl">"</span>
341
- <span class="nx">person</span><span class="p">.</span><span class="nx">attributes</span> <span class="c1">// { firstName: "John", lastName: "Doe" }</span>
342
- <span class="nx">person</span><span class="p">.</span><span class="nx">fullName</span> <span class="c1">// "John Doe"</span></code></pre></figure>
343
-
344
- <figure class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="kd">const</span> <span class="nx">attr</span> <span class="o">=</span> <span class="nx">spraypaint</span><span class="p">.</span><span class="nx">attr</span>
345
- <span class="kd">const</span> <span class="nx">Person</span> <span class="o">=</span> <span class="nx">ApplicationRecord</span><span class="p">.</span><span class="nf">extend</span><span class="p">({</span>
346
- <span class="c1">// ... code ...</span>
347
- <span class="na">attrs</span><span class="p">:</span> <span class="p">{</span>
348
- <span class="na">firstName</span><span class="p">:</span> <span class="nf">attr</span><span class="p">(),</span>
349
- <span class="na">lastName</span><span class="p">:</span> <span class="nf">attr</span><span class="p">(),</span>
350
- <span class="na">age</span><span class="p">:</span> <span class="nf">attr</span><span class="p">()</span>
351
- <span class="p">},</span>
352
- <span class="na">methods</span><span class="p">:</span> <span class="p">{</span>
353
- <span class="na">fullName</span><span class="p">:</span> <span class="kd">function</span><span class="p">()</span> <span class="p">{</span>
354
- <span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">firstName</span> <span class="o">+</span> <span class="dl">"</span><span class="s2"> </span><span class="dl">"</span> <span class="o">+</span> <span class="k">this</span><span class="p">.</span><span class="nx">lastName</span><span class="p">;</span>
355
- <span class="p">}</span>
356
- <span class="p">}</span>
357
- <span class="p">})</span>
358
-
359
- <span class="kd">var</span> <span class="nx">person</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Person</span><span class="p">({</span> <span class="na">firstName</span><span class="p">:</span> <span class="dl">"</span><span class="s2">John</span><span class="dl">"</span> <span class="p">})</span>
360
- <span class="nx">person</span><span class="p">.</span><span class="nx">firstName</span> <span class="c1">// "John"</span>
361
- <span class="nx">person</span><span class="p">.</span><span class="nx">lastName</span> <span class="o">=</span> <span class="dl">"</span><span class="s2">Doe</span><span class="dl">"</span>
362
- <span class="nx">person</span><span class="p">.</span><span class="nx">attributes</span> <span class="c1">// { firstName: "John", lastName: "Doe" }</span>
363
- <span class="nx">person</span><span class="p">.</span><span class="nf">fullName</span><span class="p">()</span> <span class="c1">// "John Doe"</span></code></pre></figure>
364
-
365
- </div>
366
-
367
- <p>Attributes can be marked read-only, so they are never sent to the server
368
- on a write request:</p>
369
-
370
- <div class="tabs">
371
- <div class="tab typescript active">
372
- <span>Typescript</span>
373
- </div>
374
- <div class="tab javascript">
375
- <span>Javascript</span>
376
- </div>
377
- </div>
378
-
379
- <div class="code-tabs">
380
-
381
- <figure class="highlight"><pre><code class="language-typescript" data-lang="typescript"><span class="p">@</span><span class="nd">Attr</span><span class="p">({</span> <span class="na">persist</span><span class="p">:</span> <span class="kc">false</span> <span class="p">})</span> <span class="nx">createdAt</span><span class="p">:</span> <span class="kr">string</span>
382
- <span class="p">@</span><span class="nd">Attr</span><span class="p">({</span> <span class="na">persist</span><span class="p">:</span> <span class="kc">false</span> <span class="p">})</span> <span class="nx">updatedAt</span><span class="p">:</span> <span class="kr">string</span></code></pre></figure>
383
-
384
- <figure class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="nx">attrs</span><span class="p">:</span> <span class="p">{</span>
385
- <span class="nl">createdAt</span><span class="p">:</span> <span class="nf">attr</span><span class="p">({</span> <span class="na">persist</span><span class="p">:</span> <span class="kc">false</span> <span class="p">}),</span>
386
- <span class="nx">updatedAt</span><span class="p">:</span> <span class="nf">attr</span><span class="p">({</span> <span class="na">persist</span><span class="p">:</span> <span class="kc">false</span> <span class="p">})</span>
387
- <span class="p">}</span></code></pre></figure>
388
-
389
- </div>
390
-
391
- <h4 id="defining-relationships">Defining Relationships</h4>
392
-
393
- <p>Just like <code class="language-plaintext highlighter-rouge">ActiveRecord</code>, there are <code class="language-plaintext highlighter-rouge">HasMany</code>, <code class="language-plaintext highlighter-rouge">BelongsTo</code>, and
394
- <code class="language-plaintext highlighter-rouge">HasOne</code> relationships:</p>
395
-
396
- <div class="tabs">
397
- <div class="tab typescript active">
398
- <span>Typescript</span>
399
- </div>
400
- <div class="tab javascript">
401
- <span>Javascript</span>
402
- </div>
403
- </div>
404
-
405
- <div class="code-tabs">
406
-
407
- <figure class="highlight"><pre><code class="language-typescript" data-lang="typescript"><span class="p">@</span><span class="nd">Model</span><span class="p">()</span>
408
- <span class="kd">class</span> <span class="nc">Dog</span> <span class="kd">extends</span> <span class="nc">ApplicationRecord</span> <span class="p">{</span>
409
- <span class="c1">// ... code ...</span>
410
- <span class="p">@</span><span class="nd">BelongsTo</span><span class="p">()</span> <span class="nx">person</span><span class="p">:</span> <span class="nx">Person</span><span class="p">[]</span>
411
- <span class="p">}</span>
412
-
413
- <span class="kd">class</span> <span class="nc">Person</span> <span class="kd">extends</span> <span class="nc">ApplicationRecord</span> <span class="p">{</span>
414
- <span class="c1">// ... code ...</span>
415
- <span class="p">@</span><span class="nd">HasMany</span><span class="p">()</span> <span class="nx">dogs</span><span class="p">:</span> <span class="nx">Dog</span><span class="p">[]</span>
416
- <span class="p">}</span></code></pre></figure>
417
-
418
- <figure class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="kd">const</span> <span class="nx">hasMany</span> <span class="o">=</span> <span class="nx">spraypaint</span><span class="p">.</span><span class="nx">hasMany</span>
419
- <span class="kd">const</span> <span class="nx">belongsTo</span> <span class="o">=</span> <span class="nx">spraypaint</span><span class="p">.</span><span class="nx">belongsTo</span>
420
-
421
- <span class="kd">const</span> <span class="nx">Person</span> <span class="o">=</span> <span class="nx">ApplicationRecord</span><span class="p">.</span><span class="nf">extend</span><span class="p">({</span>
422
- <span class="c1">// ... code ...</span>
423
- <span class="na">attrs</span><span class="p">:</span> <span class="p">{</span>
424
- <span class="na">dogs</span><span class="p">:</span> <span class="nf">hasMany</span><span class="p">()</span>
425
- <span class="p">}</span>
426
- <span class="p">})</span>
427
-
428
- <span class="kd">const</span> <span class="nx">Dog</span> <span class="o">=</span> <span class="nx">ApplicationRecord</span><span class="p">.</span><span class="nf">extend</span><span class="p">({</span>
429
- <span class="c1">// ... code ...</span>
430
- <span class="na">attrs</span><span class="p">:</span> <span class="p">{</span>
431
- <span class="na">person</span><span class="p">:</span> <span class="nf">belongsTo</span><span class="p">()</span>
432
- <span class="p">}</span>
433
- <span class="p">})</span></code></pre></figure>
434
-
435
- </div>
436
-
437
- <p>By default, we expect the relationship name to correspond to a
438
- pluralized <code class="language-plaintext highlighter-rouge">jsonapiType</code> on a separate <code class="language-plaintext highlighter-rouge">Model</code>. If your models don’t
439
- use this convention, feel free to supply it explicitly:</p>
440
-
441
- <div class="tabs">
442
- <div class="tab typescript active">
443
- <span>Typescript</span>
444
- </div>
445
- <div class="tab javascript">
446
- <span>Javascript</span>
447
- </div>
448
- </div>
449
-
450
- <div class="code-tabs">
451
-
452
- <figure class="highlight"><pre><code class="language-typescript" data-lang="typescript"><span class="p">@</span><span class="nd">Model</span><span class="p">()</span>
453
- <span class="kd">class</span> <span class="nc">Dog</span> <span class="kd">extends</span> <span class="nc">ApplicationRecord</span> <span class="p">{</span>
454
- <span class="c1">// ... code ...</span>
455
- <span class="p">@</span><span class="nd">BelongsTo</span><span class="p">(</span><span class="dl">'</span><span class="s1">people</span><span class="dl">'</span><span class="p">)</span> <span class="nx">owner</span><span class="p">:</span> <span class="nx">Person</span><span class="p">[]</span>
456
- <span class="p">}</span>
457
-
458
- <span class="c1">// alternatively, specify the class directly</span>
459
-
460
- <span class="kd">class</span> <span class="nc">Dog</span> <span class="kd">extends</span> <span class="nc">ApplicationRecord</span> <span class="p">{</span>
461
- <span class="c1">// ... code ...</span>
462
- <span class="p">@</span><span class="nd">BelongsTo</span><span class="p">(</span><span class="nx">Person</span><span class="p">)</span> <span class="nx">owner</span><span class="p">:</span> <span class="nx">Person</span><span class="p">[]</span>
463
- <span class="p">}</span></code></pre></figure>
464
-
465
- <figure class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="kd">const</span> <span class="nx">Dog</span> <span class="o">=</span> <span class="nx">ApplicationRecord</span><span class="p">.</span><span class="nf">extend</span><span class="p">({</span>
466
- <span class="c1">// ... code ...</span>
467
- <span class="na">attrs</span><span class="p">:</span> <span class="p">{</span>
468
- <span class="na">owner</span><span class="p">:</span> <span class="nf">belongsTo</span><span class="p">(</span><span class="dl">'</span><span class="s1">people</span><span class="dl">'</span><span class="p">)</span>
469
- <span class="p">}</span>
470
- <span class="p">})</span></code></pre></figure>
471
-
472
- </div>
473
-
474
- <p>Relationships can be:</p>
475
-
476
- <ul>
477
- <li>Assigned via constructor</li>
478
- <li>Assigned directly</li>
479
- <li>Automatically loaded via <code class="language-plaintext highlighter-rouge">.includes()</code> (see <a href="/1.13/js/reads">reads</a>)</li>
480
- <li>Saved in a single request <code class="language-plaintext highlighter-rouge">.save({ with: 'dogs' })</code> (see
481
- <a href="/1.13/js/writes">writes</a>)</li>
482
- </ul>
483
-
484
- <div class="tabs">
485
- <div class="tab typescript active">
486
- <span>Typescript</span>
487
- </div>
488
- <div class="tab javascript">
489
- <span>Javascript</span>
490
- </div>
491
- </div>
492
-
493
- <div class="code-tabs">
494
-
495
- <figure class="highlight"><pre><code class="language-typescript" data-lang="typescript"><span class="kd">let</span> <span class="nx">dog</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Dog</span><span class="p">({</span> <span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Fido</span><span class="dl">"</span> <span class="p">})</span>
496
- <span class="kd">let</span> <span class="nx">person</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Person</span><span class="p">({</span> <span class="na">dogs</span><span class="p">:</span> <span class="p">[</span><span class="nx">dog</span><span class="p">]</span> <span class="p">})</span>
497
- <span class="nx">person</span><span class="p">.</span><span class="nx">dogs</span><span class="p">[</span><span class="mi">0</span><span class="p">].</span><span class="nx">name</span> <span class="c1">// "Fido"</span>
498
-
499
- <span class="kd">let</span> <span class="nx">person</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Person</span><span class="p">()</span>
500
- <span class="nx">person</span><span class="p">.</span><span class="nx">dogs</span> <span class="o">=</span> <span class="p">[</span><span class="nx">dog</span><span class="p">]</span>
501
- <span class="nx">person</span><span class="p">.</span><span class="nx">dogs</span><span class="p">[</span><span class="mi">0</span><span class="p">].</span><span class="nx">name</span> <span class="c1">// "Fido"</span>
502
-
503
- <span class="c1">// Will auto-create Dog instance</span>
504
- <span class="kd">let</span> <span class="nx">person</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Person</span><span class="p">({</span> <span class="na">dogs</span><span class="p">:</span> <span class="p">[{</span> <span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Scooby</span><span class="dl">"</span> <span class="p">}]</span> <span class="p">})</span>
505
- <span class="nx">person</span><span class="p">.</span><span class="nx">dogs</span><span class="p">[</span><span class="mi">0</span><span class="p">].</span><span class="nx">name</span> <span class="c1">// "Scooby"</span>
506
-
507
- <span class="kd">let</span> <span class="nx">person</span> <span class="o">=</span> <span class="p">(</span><span class="k">await</span> <span class="nx">Person</span><span class="p">.</span><span class="nf">includes</span><span class="p">(</span><span class="dl">'</span><span class="s1">dogs</span><span class="dl">'</span><span class="p">)).</span><span class="nx">data</span>
508
- <span class="nx">person</span><span class="p">.</span><span class="nx">dogs</span> <span class="c1">// array of Dog instances from the server</span>
509
- </code></pre></figure>
510
-
511
- <figure class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="kd">var</span> <span class="nx">dog</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Dog</span><span class="p">({</span> <span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Fido</span><span class="dl">"</span> <span class="p">})</span>
512
- <span class="kd">var</span> <span class="nx">person</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Person</span><span class="p">({</span> <span class="na">dogs</span><span class="p">:</span> <span class="p">[</span><span class="nx">dog</span><span class="p">]</span> <span class="p">})</span>
513
- <span class="nx">person</span><span class="p">.</span><span class="nx">dogs</span><span class="p">[</span><span class="mi">0</span><span class="p">].</span><span class="nx">name</span> <span class="c1">// "Fido"</span>
514
-
515
- <span class="kd">let</span> <span class="nx">person</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Person</span><span class="p">()</span>
516
- <span class="nx">person</span><span class="p">.</span><span class="nx">dogs</span> <span class="o">=</span> <span class="p">[</span><span class="nx">dog</span><span class="p">]</span>
517
- <span class="nx">person</span><span class="p">.</span><span class="nx">dogs</span><span class="p">[</span><span class="mi">0</span><span class="p">].</span><span class="nx">name</span> <span class="c1">// "Fido"</span>
518
-
519
- <span class="c1">// Will auto-create Dog instance</span>
520
- <span class="kd">var</span> <span class="nx">person</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Person</span><span class="p">({</span> <span class="na">dogs</span><span class="p">:</span> <span class="p">[{</span> <span class="na">name</span><span class="p">:</span> <span class="dl">"</span><span class="s2">Scooby</span><span class="dl">"</span> <span class="p">}]</span> <span class="p">})</span>
521
- <span class="nx">person</span><span class="p">.</span><span class="nx">dogs</span><span class="p">[</span><span class="mi">0</span><span class="p">].</span><span class="nx">name</span> <span class="c1">// "Scooby"</span>
522
-
523
- <span class="nx">Person</span><span class="p">.</span><span class="nf">includes</span><span class="p">(</span><span class="dl">'</span><span class="s1">dogs</span><span class="dl">'</span><span class="p">).</span><span class="nf">then</span><span class="p">((</span><span class="nx">response</span><span class="p">)</span> <span class="o">=&gt;</span> <span class="p">{</span>
524
- <span class="kd">var</span> <span class="nx">person</span> <span class="o">=</span> <span class="nx">response</span><span class="p">.</span><span class="nx">data</span>
525
- <span class="nx">person</span><span class="p">.</span><span class="nx">dogs</span> <span class="c1">// array of Dog instances from the server</span>
526
- <span class="p">})</span>
527
- </code></pre></figure>
528
-
529
- </div>
530
-
531
- <div class="clearfix">
532
- <h2 id="next">
533
- <a href="/1.13/js/reads">
534
- NEXT:
535
- <small>Reads</small>
536
- &raquo;
537
- </a>
538
- </h2>
539
- </div>
540
- </div>
541
- </div>
542
-
543
- </div>
544
- </div>
545
- </main>
546
- <div class="main-footer main-footer--dark">
547
- <div class="container">
548
- <div class="row">
549
- <div class="col-sm-4 menu">
550
- <h3>Overview</h3>
551
- <ul>
552
- <li>
553
- <a href="/1.13/quickstart">Quickstart</a>
554
- </li>
555
- <li>
556
- <a href="/1.13/tutorial">Tutorial</a>
557
- </li>
558
- <li>
559
- <a href="/1.13/guides">Guides</a>
560
- </li>
561
- </ul>
562
- </div>
563
- <div class="col-sm-4 menu">
564
- <h3>Contact</h3>
565
- <ul>
566
- <li>
567
- <a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
568
- </li>
569
- <li>
570
- <a href="mailto:richmolj@gmail.com">Email</a>
571
- </li>
572
- </ul>
573
- </div>
574
- <div class="col-sm-4 menu">
575
- <h3>Related</h3>
576
- <ul>
577
- <li>
578
- <a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
579
- </li>
580
- <li>
581
- <a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
582
- </li>
583
- <li>
584
- <a target="_blank" href="https://vuejs.org/">VueJS</a>
585
- </li>
586
- </ul>
587
- </div>
588
- </div>
589
- </div>
590
- </div>
591
-
592
- <script type="text/javascript">
593
- $(function () {
594
-
595
- var flipTabs = function() {
596
- var isTS = true;
597
- if (localStorage.getItem('js-lang') === 'javascript') {
598
- isTS = false;
599
- }
600
-
601
- $('.code-tabs').each(function(index, el) {
602
- if (isTS) {
603
- console.log('hiding js');
604
- $($(el).children()[1]).hide();
605
- $($(el).children()[0]).show();
606
- } else {
607
- console.log('hiding ts');
608
- $($(el).children()[0]).hide();
609
- $($(el).children()[1]).show();
610
- }
611
- });
612
-
613
- if (isTS) {
614
- $('.tab.typescript').addClass('active');
615
- $('.tab.javascript').removeClass('active');
616
- } else {
617
- $('.tab.typescript').removeClass('active');
618
- $('.tab.javascript').addClass('active');
619
- }
620
- }
621
-
622
- $('.tab').click(function() {
623
- if ($(this).hasClass('typescript')) {
624
- localStorage.setItem('js-lang', 'typescript');
625
- } else {
626
- localStorage.setItem('js-lang', 'javascript');
627
- }
628
-
629
- flipTabs();
630
- });
631
-
632
- flipTabs();
633
- })
634
- </script>
635
-
636
- </body>
637
- </html>