chore(#307): add method examples (#331)

druxt · Oct 10, 2021 · cf43025 · cf43025
1 parent c7b267a
commit cf43025
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/packages/druxt/src/client.js b/packages/druxt/src/client.js
@@ -139,6 +139,9 @@ class DruxtClient {
   /**
    * Create a JSON:API resource.
    *
+   * @example @lang js
+   * await this.$druxt.createResource({ type: 'node--page', attributes: {}, relationships: {} })
+   *
    * @param {object} resource - The JSON:API resource object
    *
    * @returns {object} The response data
@@ -309,6 +312,9 @@ class DruxtClient {
   /**
    * Update a JSON:API resource.
    *
+   * @example @lang js
+   * await this.$druxt.updateResource({ type: 'node--page', id, attributes: {}, relationships: {} })
+   *
    * @param {object} resource - The JSON:API resource object
    *
    * @returns {object} The response data