chore(#71): add example

druxt · Oct 10, 2021 · 992590b · 992590b
1 parent 4f73ae2
commit 992590b
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/packages/druxt/src/client.js b/packages/druxt/src/client.js
@@ -278,6 +278,9 @@ class DruxtClient {
   /**
    * Get the related resources from a specified JSON:API resource.
    *
+   * @example @lang js
+   * const related = this.$druxt.getRelated('node--page', id, 'uid')
+   *
    * @param {string} type - The JSON:API Resource type.
    * @param {string} id - The Drupal resource UUID.
    * @param {string} related - The relationship name.