From 05346a30d37de413193fa543c13feee97c501521 Mon Sep 17 00:00:00 2001 From: GraphQL-Markdown bot Date: Sun, 23 Jun 2024 11:13:08 +0000 Subject: [PATCH] :memo: update documentation (645bbe8aac811fa70102ed2b3d18785152b9b448) --- 404.html | 6 +- api/category/const/index.html | 6 +- api/category/directives/index.html | 6 +- api/category/graphql-markdowncore/index.html | 6 +- api/category/graphql-markdowndiff/index.html | 6 +- .../graphql-markdowndocusaurus/index.html | 6 +- .../graphql-markdowngraphql/index.html | 6 +- .../graphql-markdownhelpers/index.html | 6 +- .../graphql-markdownlogger/index.html | 6 +- .../graphql-markdownprinter-legacy/index.html | 6 +- api/category/graphql-markdowntypes/index.html | 6 +- api/category/graphql-markdownutils/index.html | 6 +- api/category/graphql/index.html | 6 +- api/category/utils/index.html | 6 +- api/core/config/index.html | 50 +++---- api/core/diff/index.html | 10 +- api/core/generator/index.html | 8 +- api/core/graphql-config/index.html | 16 +-- api/core/printer/index.html | 8 +- api/core/renderer/index.html | 32 ++--- api/diff/globals/index.html | 6 +- api/docusaurus/globals/index.html | 6 +- api/graphql/directive/index.html | 30 ++-- api/graphql/formatter/index.html | 12 +- api/graphql/group/index.html | 18 +-- api/graphql/guard/index.html | 22 +-- api/graphql/introspection/index.html | 72 +++------- api/graphql/loader/index.html | 21 +-- api/graphql/relation/index.html | 31 ++-- api/helpers/directives/descriptor/index.html | 8 +- api/helpers/directives/tag/index.html | 10 +- api/helpers/utils/interpolate/index.html | 14 +- api/index.html | 6 +- api/logger/globals/index.html | 6 +- api/printer-legacy/badge/index.html | 14 +- api/printer-legacy/code/index.html | 14 +- api/printer-legacy/common/index.html | 20 +-- api/printer-legacy/const/mdx/index.html | 8 +- api/printer-legacy/const/options/index.html | 18 +-- api/printer-legacy/const/strings/index.html | 32 ++--- api/printer-legacy/directive/index.html | 16 +-- api/printer-legacy/example/index.html | 10 +- api/printer-legacy/frontmatter/index.html | 12 +- .../graphql/directive/index.html | 10 +- api/printer-legacy/graphql/enum/index.html | 10 +- api/printer-legacy/graphql/input/index.html | 10 +- .../graphql/interface/index.html | 10 +- api/printer-legacy/graphql/object/index.html | 12 +- .../graphql/operation/index.html | 14 +- api/printer-legacy/graphql/scalar/index.html | 12 +- api/printer-legacy/graphql/union/index.html | 10 +- api/printer-legacy/group/index.html | 8 +- api/printer-legacy/link/index.html | 30 ++-- api/printer-legacy/printer/index.html | 56 ++++---- api/printer-legacy/relation/index.html | 14 +- api/printer-legacy/section/index.html | 24 ++-- api/types/globals/index.html | 6 +- api/utils/array/index.html | 20 +-- api/utils/fs/index.html | 22 +-- api/utils/object/index.html | 12 +- api/utils/prettier/index.html | 30 +--- api/utils/string/index.html | 75 +++------- api/utils/url/index.html | 6 +- assets/js/0999c2f7.db8278b6.js | 1 + assets/js/0aee5409.b2fcf902.js | 1 + assets/js/0cba5814.d012126a.js | 1 + assets/js/24561158.602deab3.js | 1 + assets/js/27b16d00.861a1040.js | 1 + assets/js/287d049f.60375e54.js | 1 + assets/js/2c24e59e.7100aa87.js | 1 + assets/js/2e57b0d8.f2287ffd.js | 1 + assets/js/4ea83d6a.97829d76.js | 1 + assets/js/50c19381.f66fcf75.js | 1 + assets/js/5c7c1faa.8ba54d84.js | 1 + assets/js/65ff014b.43b280a3.js | 1 + assets/js/67c5b3f9.4c2aed9d.js | 1 + assets/js/690431c1.f73e169e.js | 1 + assets/js/6b9371a2.12a4b159.js | 1 + assets/js/6bfed8d6.d34269ac.js | 1 + assets/js/6ca537f5.75fb5db1.js | 1 + assets/js/6e8812e8.1f5ce259.js | 1 + assets/js/7c7d3934.4e5d7aea.js | 1 + assets/js/847a047e.315ac7a2.js | 1 + assets/js/881202c4.5b4d600d.js | 1 + assets/js/89554646.a9762ba0.js | 1 + assets/js/8cd5ecab.df083543.js | 1 + assets/js/8d936e6f.2034f4cd.js | 1 + assets/js/92c78daf.cb62e0a7.js | 1 + assets/js/988d23d8.d5940aae.js | 1 + assets/js/9d9f8394.4a57b8d9.js | 1 + assets/js/9de9df72.0c2d7c9c.js | 1 + assets/js/ab25c79e.62e1fbc7.js | 1 + assets/js/ab3156a3.834c8454.js | 1 + assets/js/abd6157e.1a9d1800.js | 1 + assets/js/aeddb196.9b060439.js | 1 + assets/js/af7f826a.a26e16ca.js | 1 + assets/js/b1aa3f71.9c4fd7d6.js | 1 + assets/js/b48f7d9d.6277b3c4.js | 1 + assets/js/b835b301.51b75b23.js | 1 + assets/js/b9652c4a.b9d7b514.js | 1 + assets/js/bcab2f54.ed4b2e71.js | 1 + assets/js/bff4d555.f0b15209.js | 1 + assets/js/c14b7bba.140ba76d.js | 1 + assets/js/c49f35ad.8dec64d2.js | 1 + assets/js/cb0f12d1.9b90d790.js | 1 + assets/js/d262eff2.e37dcf97.js | 1 + assets/js/d565c98c.b10ed2f2.js | 1 + assets/js/d56b581c.0d7ebfbf.js | 1 + assets/js/da360fa0.dcc3b7f3.js | 1 + assets/js/e16884a3.79570acc.js | 1 + assets/js/e3e63689.8c137ef7.js | 1 + assets/js/e47ee25b.437323b2.js | 1 + assets/js/e7f041fd.95f9134e.js | 1 + assets/js/e9540e45.39044c82.js | 1 + assets/js/eb4a6c9f.93c9db3c.js | 1 + assets/js/edc43b20.8d6cc523.js | 1 + assets/js/f6e8bb3b.8c0ea89b.js | 1 + assets/js/main.89d2e621.js | 2 + assets/js/main.89d2e621.js.LICENSE.txt | 133 ++++++++++++++++++ assets/js/runtime~main.bc21c275.js | 1 + docs/advanced/additional-schema/index.html | 6 +- .../custom-deprecated-section/index.html | 6 +- docs/advanced/custom-directive/index.html | 10 +- docs/advanced/custom-root-types/index.html | 8 +- docs/advanced/docs-multi-instance/index.html | 8 +- docs/advanced/examples/index.html | 6 +- docs/advanced/group-by-directive/index.html | 6 +- docs/advanced/homepage/index.html | 6 +- docs/advanced/schema-loading/index.html | 10 +- docs/category/advanced-settings/index.html | 6 +- docs/configuration/index.html | 6 +- docs/get-started/index.html | 6 +- docs/intro/index.html | 6 +- docs/settings/index.html | 6 +- docs/troubleshooting/index.html | 8 +- docs/try-it/index.html | 6 +- .../default/api/directives/include/index.html | 6 +- .../default/api/directives/skip/index.html | 6 +- .../delete-activity-reply/index.html | 6 +- .../api/mutations/delete-activity/index.html | 6 +- .../mutations/delete-custom-list/index.html | 6 +- .../delete-media-list-entry/index.html | 6 +- .../api/mutations/delete-review/index.html | 6 +- .../delete-thread-comment/index.html | 6 +- .../api/mutations/delete-thread/index.html | 6 +- .../api/mutations/rate-review/index.html | 6 +- .../mutations/save-activity-reply/index.html | 6 +- .../mutations/save-list-activity/index.html | 6 +- .../save-media-list-entry/index.html | 6 +- .../save-message-activity/index.html | 6 +- .../mutations/save-recommendation/index.html | 6 +- .../api/mutations/save-review/index.html | 6 +- .../mutations/save-text-activity/index.html | 6 +- .../mutations/save-thread-comment/index.html | 6 +- .../api/mutations/save-thread/index.html | 6 +- .../mutations/toggle-activity-pin/index.html | 6 +- .../toggle-activity-subscription/index.html | 6 +- .../api/mutations/toggle-favourite/index.html | 6 +- .../api/mutations/toggle-follow/index.html | 6 +- .../api/mutations/toggle-like-v2/index.html | 6 +- .../api/mutations/toggle-like/index.html | 6 +- .../toggle-thread-subscription/index.html | 6 +- .../update-ani-chart-highlights/index.html | 6 +- .../update-ani-chart-settings/index.html | 6 +- .../update-favourite-order/index.html | 6 +- .../update-media-list-entries/index.html | 6 +- .../api/mutations/update-user/index.html | 6 +- .../api/queries/activity-reply/index.html | 6 +- .../default/api/queries/activity/index.html | 6 +- .../api/queries/airing-schedule/index.html | 6 +- .../api/queries/ani-chart-user/index.html | 6 +- .../default/api/queries/character/index.html | 6 +- .../index.html | 6 +- .../default/api/queries/follower/index.html | 6 +- .../default/api/queries/following/index.html | 6 +- .../api/queries/genre-collection/index.html | 6 +- examples/default/api/queries/like/index.html | 6 +- .../default/api/queries/markdown/index.html | 6 +- .../queries/media-list-collection/index.html | 6 +- .../default/api/queries/media-list/index.html | 6 +- .../queries/media-tag-collection/index.html | 6 +- .../api/queries/media-trend/index.html | 6 +- examples/default/api/queries/media/index.html | 6 +- .../api/queries/notification/index.html | 6 +- examples/default/api/queries/page/index.html | 6 +- .../api/queries/recommendation/index.html | 6 +- .../default/api/queries/review/index.html | 6 +- .../api/queries/site-statistics/index.html | 6 +- examples/default/api/queries/staff/index.html | 6 +- .../default/api/queries/studio/index.html | 6 +- .../api/queries/thread-comment/index.html | 6 +- .../default/api/queries/thread/index.html | 6 +- examples/default/api/queries/user/index.html | 6 +- .../default/api/queries/viewer/index.html | 6 +- examples/default/index.html | 8 +- .../types/directives/deprecated/index.html | 6 +- .../types/enums/activity-sort/index.html | 6 +- .../types/enums/activity-type/index.html | 6 +- .../types/enums/airing-sort/index.html | 6 +- .../types/enums/character-role/index.html | 6 +- .../types/enums/character-sort/index.html | 6 +- .../enums/external-link-media-type/index.html | 6 +- .../types/enums/external-link-type/index.html | 6 +- .../types/enums/likeable-type/index.html | 6 +- .../types/enums/media-format/index.html | 6 +- .../types/enums/media-list-sort/index.html | 6 +- .../types/enums/media-list-status/index.html | 6 +- .../types/enums/media-rank-type/index.html | 6 +- .../types/enums/media-relation/index.html | 6 +- .../types/enums/media-season/index.html | 6 +- .../default/types/enums/media-sort/index.html | 6 +- .../types/enums/media-source/index.html | 6 +- .../types/enums/media-status/index.html | 6 +- .../types/enums/media-trend-sort/index.html | 6 +- .../default/types/enums/media-type/index.html | 6 +- .../types/enums/mod-action-type/index.html | 6 +- .../default/types/enums/mod-role/index.html | 6 +- .../types/enums/notification-type/index.html | 6 +- .../enums/recommendation-rating/index.html | 6 +- .../enums/recommendation-sort/index.html | 6 +- .../types/enums/review-rating/index.html | 6 +- .../types/enums/review-sort/index.html | 6 +- .../enums/revision-history-action/index.html | 6 +- .../types/enums/score-format/index.html | 6 +- .../types/enums/site-trend-sort/index.html | 6 +- .../types/enums/staff-language/index.html | 6 +- .../default/types/enums/staff-sort/index.html | 6 +- .../types/enums/studio-sort/index.html | 6 +- .../types/enums/submission-sort/index.html | 6 +- .../types/enums/submission-status/index.html | 6 +- .../enums/thread-comment-sort/index.html | 6 +- .../types/enums/thread-sort/index.html | 6 +- .../default/types/enums/user-sort/index.html | 6 +- .../enums/user-staff-name-language/index.html | 6 +- .../enums/user-statistics-sort/index.html | 6 +- .../enums/user-title-language/index.html | 6 +- .../inputs/airing-schedule-input/index.html | 6 +- .../ani-chart-highlight-input/index.html | 6 +- .../inputs/character-name-input/index.html | 6 +- .../types/inputs/fuzzy-date-input/index.html | 6 +- .../list-activity-option-input/index.html | 6 +- .../media-external-link-input/index.html | 6 +- .../media-list-options-input/index.html | 6 +- .../types/inputs/media-title-input/index.html | 6 +- .../notification-option-input/index.html | 6 +- .../types/inputs/staff-name-input/index.html | 6 +- .../activity-like-notification/index.html | 6 +- .../activity-mention-notification/index.html | 6 +- .../activity-message-notification/index.html | 6 +- .../index.html | 6 +- .../activity-reply-notification/index.html | 6 +- .../index.html | 6 +- .../types/objects/activity-reply/index.html | 6 +- .../objects/airing-notification/index.html | 6 +- .../objects/airing-progression/index.html | 6 +- .../airing-schedule-connection/index.html | 6 +- .../objects/airing-schedule-edge/index.html | 6 +- .../types/objects/airing-schedule/index.html | 6 +- .../types/objects/ani-chart-user/index.html | 6 +- .../objects/character-connection/index.html | 6 +- .../types/objects/character-edge/index.html | 6 +- .../types/objects/character-image/index.html | 6 +- .../types/objects/character-name/index.html | 6 +- .../index.html | 6 +- .../character-submission-edge/index.html | 6 +- .../objects/character-submission/index.html | 6 +- .../types/objects/character/index.html | 6 +- .../default/types/objects/deleted/index.html | 6 +- .../types/objects/favourites/index.html | 6 +- .../objects/following-notification/index.html | 6 +- .../types/objects/format-stats/index.html | 6 +- .../types/objects/fuzzy-date/index.html | 6 +- .../types/objects/genre-stats/index.html | 6 +- .../types/objects/internal-page/index.html | 6 +- .../objects/list-activity-option/index.html | 6 +- .../types/objects/list-activity/index.html | 6 +- .../types/objects/list-score-stats/index.html | 6 +- .../types/objects/media-character/index.html | 6 +- .../types/objects/media-connection/index.html | 6 +- .../objects/media-cover-image/index.html | 6 +- .../media-data-change-notification/index.html | 6 +- .../media-deletion-notification/index.html | 6 +- .../types/objects/media-edge/index.html | 6 +- .../objects/media-external-link/index.html | 6 +- .../objects/media-list-collection/index.html | 6 +- .../types/objects/media-list-group/index.html | 6 +- .../objects/media-list-options/index.html | 6 +- .../media-list-type-options/index.html | 6 +- .../types/objects/media-list/index.html | 6 +- .../media-merge-notification/index.html | 6 +- .../types/objects/media-rank/index.html | 6 +- .../types/objects/media-stats/index.html | 6 +- .../media-streaming-episode/index.html | 6 +- .../media-submission-comparison/index.html | 6 +- .../objects/media-submission-edge/index.html | 6 +- .../types/objects/media-submission/index.html | 6 +- .../types/objects/media-tag/index.html | 6 +- .../types/objects/media-title/index.html | 6 +- .../types/objects/media-trailer/index.html | 6 +- .../objects/media-trend-connection/index.html | 6 +- .../types/objects/media-trend-edge/index.html | 6 +- .../types/objects/media-trend/index.html | 6 +- .../default/types/objects/media/index.html | 6 +- .../types/objects/message-activity/index.html | 6 +- .../types/objects/mod-action/index.html | 6 +- .../objects/notification-option/index.html | 6 +- .../types/objects/page-info/index.html | 6 +- .../default/types/objects/page/index.html | 6 +- .../types/objects/parsed-markdown/index.html | 6 +- .../recommendation-connection/index.html | 6 +- .../objects/recommendation-edge/index.html | 6 +- .../types/objects/recommendation/index.html | 6 +- .../index.html | 6 +- .../default/types/objects/report/index.html | 6 +- .../objects/review-connection/index.html | 6 +- .../types/objects/review-edge/index.html | 6 +- .../default/types/objects/review/index.html | 6 +- .../types/objects/revision-history/index.html | 6 +- .../objects/score-distribution/index.html | 6 +- .../types/objects/site-statistics/index.html | 6 +- .../objects/site-trend-connection/index.html | 6 +- .../types/objects/site-trend-edge/index.html | 6 +- .../types/objects/site-trend/index.html | 6 +- .../types/objects/staff-connection/index.html | 6 +- .../types/objects/staff-edge/index.html | 6 +- .../types/objects/staff-image/index.html | 6 +- .../types/objects/staff-name/index.html | 6 +- .../types/objects/staff-role-type/index.html | 6 +- .../types/objects/staff-stats/index.html | 6 +- .../types/objects/staff-submission/index.html | 6 +- .../default/types/objects/staff/index.html | 6 +- .../objects/status-distribution/index.html | 6 +- .../objects/studio-connection/index.html | 6 +- .../types/objects/studio-edge/index.html | 6 +- .../types/objects/studio-stats/index.html | 6 +- .../default/types/objects/studio/index.html | 6 +- .../types/objects/tag-stats/index.html | 6 +- .../types/objects/text-activity/index.html | 6 +- .../types/objects/thread-category/index.html | 6 +- .../index.html | 6 +- .../index.html | 6 +- .../index.html | 6 +- .../index.html | 6 +- .../types/objects/thread-comment/index.html | 6 +- .../thread-like-notification/index.html | 6 +- .../default/types/objects/thread/index.html | 6 +- .../objects/user-activity-history/index.html | 6 +- .../types/objects/user-avatar/index.html | 6 +- .../objects/user-country-statistic/index.html | 6 +- .../objects/user-format-statistic/index.html | 6 +- .../objects/user-genre-statistic/index.html | 6 +- .../objects/user-length-statistic/index.html | 6 +- .../types/objects/user-mod-data/index.html | 6 +- .../types/objects/user-options/index.html | 6 +- .../objects/user-previous-name/index.html | 6 +- .../user-release-year-statistic/index.html | 6 +- .../objects/user-score-statistic/index.html | 6 +- .../objects/user-staff-statistic/index.html | 6 +- .../user-start-year-statistic/index.html | 6 +- .../objects/user-statistic-types/index.html | 6 +- .../types/objects/user-statistics/index.html | 6 +- .../types/objects/user-stats/index.html | 6 +- .../objects/user-status-statistic/index.html | 6 +- .../objects/user-studio-statistic/index.html | 6 +- .../objects/user-tag-statistic/index.html | 6 +- .../user-voice-actor-statistic/index.html | 6 +- .../default/types/objects/user/index.html | 6 +- .../types/objects/year-stats/index.html | 6 +- .../default/types/scalars/boolean/index.html | 6 +- .../types/scalars/country-code/index.html | 6 +- .../default/types/scalars/float/index.html | 6 +- .../types/scalars/fuzzy-date-int/index.html | 6 +- examples/default/types/scalars/id/index.html | 6 +- examples/default/types/scalars/int/index.html | 6 +- .../default/types/scalars/json/index.html | 6 +- .../default/types/scalars/string/index.html | 6 +- .../types/unions/activity-union/index.html | 6 +- .../types/unions/likeable-union/index.html | 6 +- .../unions/notification-union/index.html | 6 +- examples/group-by/category/common/index.html | 6 +- .../group-by/category/course-1/index.html | 6 +- examples/group-by/category/course/index.html | 6 +- .../group-by/category/deprecated/index.html | 6 +- .../group-by/category/directives/index.html | 6 +- examples/group-by/category/enums/index.html | 6 +- examples/group-by/category/grade/index.html | 6 +- .../group-by/category/interfaces/index.html | 6 +- .../group-by/category/mutations-1/index.html | 6 +- .../group-by/category/mutations/index.html | 6 +- examples/group-by/category/objects/index.html | 6 +- .../group-by/category/queries-1/index.html | 6 +- .../group-by/category/queries-2/index.html | 6 +- .../group-by/category/queries-3/index.html | 6 +- examples/group-by/category/queries/index.html | 6 +- examples/group-by/category/scalars/index.html | 6 +- .../common/directives/auth/index.html | 6 +- .../common/directives/beta/index.html | 6 +- .../common/directives/complexity/index.html | 6 +- .../common/directives/deprecated/index.html | 6 +- .../group-by/common/directives/doc/index.html | 6 +- .../common/directives/example/index.html | 6 +- .../common/directives/include/index.html | 6 +- .../common/directives/no-doc/index.html | 8 +- .../common/directives/one-of/index.html | 14 ++ .../common/directives/skip/index.html | 8 +- .../common/directives/specified-by/index.html | 6 +- .../group-by/common/enums/roles/index.html | 6 +- .../common/interfaces/record/index.html | 6 +- .../group-by/common/objects/course/index.html | 6 +- .../objects/department-information/index.html | 6 +- .../common/objects/semester/index.html | 6 +- .../common/queries/search-role/index.html | 6 +- .../common/scalars/boolean/index.html | 6 +- .../group-by/common/scalars/date/index.html | 6 +- .../common/scalars/email-address/index.html | 6 +- .../group-by/common/scalars/id/index.html | 6 +- .../group-by/common/scalars/int/index.html | 6 +- .../common/scalars/phone-number/index.html | 6 +- .../group-by/common/scalars/string/index.html | 6 +- .../group-by/common/scalars/time/index.html | 6 +- .../group-by/common/scalars/url/index.html | 6 +- .../course/mutations/add-course/index.html | 6 +- .../course/mutations/drop-course/index.html | 6 +- .../course/queries/all-courses/index.html | 6 +- .../group-by/course/queries/course/index.html | 6 +- .../course/queries/math-courses/index.html | 6 +- .../course/queries/science-courses/index.html | 6 +- .../grade/mutations/update-gpa/index.html | 6 +- .../grade/mutations/update-grade/index.html | 6 +- .../group-by/grade/queries/gpa/index.html | 6 +- .../grade/queries/un-weighted-gpa/index.html | 6 +- .../grade/queries/weighted-gpa/index.html | 6 +- examples/group-by/index.html | 8 +- index.html | 6 +- search-index-docs-api-current.json | 2 +- search-index-docs-default-current.json | 2 +- ...ch-index-docs-example-default-current.json | 2 +- ...h-index-docs-example-group-by-current.json | 2 +- 438 files changed, 1588 insertions(+), 1529 deletions(-) create mode 100644 assets/js/0999c2f7.db8278b6.js create mode 100644 assets/js/0aee5409.b2fcf902.js create mode 100644 assets/js/0cba5814.d012126a.js create mode 100644 assets/js/24561158.602deab3.js create mode 100644 assets/js/27b16d00.861a1040.js create mode 100644 assets/js/287d049f.60375e54.js create mode 100644 assets/js/2c24e59e.7100aa87.js create mode 100644 assets/js/2e57b0d8.f2287ffd.js create mode 100644 assets/js/4ea83d6a.97829d76.js create mode 100644 assets/js/50c19381.f66fcf75.js create mode 100644 assets/js/5c7c1faa.8ba54d84.js create mode 100644 assets/js/65ff014b.43b280a3.js create mode 100644 assets/js/67c5b3f9.4c2aed9d.js create mode 100644 assets/js/690431c1.f73e169e.js create mode 100644 assets/js/6b9371a2.12a4b159.js create mode 100644 assets/js/6bfed8d6.d34269ac.js create mode 100644 assets/js/6ca537f5.75fb5db1.js create mode 100644 assets/js/6e8812e8.1f5ce259.js create mode 100644 assets/js/7c7d3934.4e5d7aea.js create mode 100644 assets/js/847a047e.315ac7a2.js create mode 100644 assets/js/881202c4.5b4d600d.js create mode 100644 assets/js/89554646.a9762ba0.js create mode 100644 assets/js/8cd5ecab.df083543.js create mode 100644 assets/js/8d936e6f.2034f4cd.js create mode 100644 assets/js/92c78daf.cb62e0a7.js create mode 100644 assets/js/988d23d8.d5940aae.js create mode 100644 assets/js/9d9f8394.4a57b8d9.js create mode 100644 assets/js/9de9df72.0c2d7c9c.js create mode 100644 assets/js/ab25c79e.62e1fbc7.js create mode 100644 assets/js/ab3156a3.834c8454.js create mode 100644 assets/js/abd6157e.1a9d1800.js create mode 100644 assets/js/aeddb196.9b060439.js create mode 100644 assets/js/af7f826a.a26e16ca.js create mode 100644 assets/js/b1aa3f71.9c4fd7d6.js create mode 100644 assets/js/b48f7d9d.6277b3c4.js create mode 100644 assets/js/b835b301.51b75b23.js create mode 100644 assets/js/b9652c4a.b9d7b514.js create mode 100644 assets/js/bcab2f54.ed4b2e71.js create mode 100644 assets/js/bff4d555.f0b15209.js create mode 100644 assets/js/c14b7bba.140ba76d.js create mode 100644 assets/js/c49f35ad.8dec64d2.js create mode 100644 assets/js/cb0f12d1.9b90d790.js create mode 100644 assets/js/d262eff2.e37dcf97.js create mode 100644 assets/js/d565c98c.b10ed2f2.js create mode 100644 assets/js/d56b581c.0d7ebfbf.js create mode 100644 assets/js/da360fa0.dcc3b7f3.js create mode 100644 assets/js/e16884a3.79570acc.js create mode 100644 assets/js/e3e63689.8c137ef7.js create mode 100644 assets/js/e47ee25b.437323b2.js create mode 100644 assets/js/e7f041fd.95f9134e.js create mode 100644 assets/js/e9540e45.39044c82.js create mode 100644 assets/js/eb4a6c9f.93c9db3c.js create mode 100644 assets/js/edc43b20.8d6cc523.js create mode 100644 assets/js/f6e8bb3b.8c0ea89b.js create mode 100644 assets/js/main.89d2e621.js create mode 100644 assets/js/main.89d2e621.js.LICENSE.txt create mode 100644 assets/js/runtime~main.bc21c275.js create mode 100644 examples/group-by/common/directives/one-of/index.html diff --git a/404.html b/404.html index 2802f0732..615e99820 100644 --- a/404.html +++ b/404.html @@ -4,10 +4,10 @@ Page Not Found | GraphQL-Markdown - - + + -
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
+
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/category/const/index.html b/api/category/const/index.html index 3e741b388..1d40c17dc 100644 --- a/api/category/const/index.html +++ b/api/category/const/index.html @@ -4,10 +4,10 @@ const | GraphQL-Markdown - - + + -
Skip to main content

const

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
+
Skip to main content

const

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/category/directives/index.html b/api/category/directives/index.html index 75ad096a9..2a3c92a38 100644 --- a/api/category/directives/index.html +++ b/api/category/directives/index.html @@ -4,10 +4,10 @@ directives | GraphQL-Markdown - - + + -
Skip to main content

directives

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
+
Skip to main content

directives

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/category/graphql-markdowncore/index.html b/api/category/graphql-markdowncore/index.html index c5816e23f..0ca9a1ad6 100644 --- a/api/category/graphql-markdowncore/index.html +++ b/api/category/graphql-markdowncore/index.html @@ -4,10 +4,10 @@ @graphql-markdown/core | GraphQL-Markdown - - + + -
Skip to main content

@graphql-markdown/core

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
+
Skip to main content

@graphql-markdown/core

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/category/graphql-markdowndiff/index.html b/api/category/graphql-markdowndiff/index.html index bf19930d8..cf388dda6 100644 --- a/api/category/graphql-markdowndiff/index.html +++ b/api/category/graphql-markdowndiff/index.html @@ -4,10 +4,10 @@ @graphql-markdown/diff | GraphQL-Markdown - - + + -
Skip to main content

@graphql-markdown/diff

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
+
Skip to main content

@graphql-markdown/diff

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/category/graphql-markdowndocusaurus/index.html b/api/category/graphql-markdowndocusaurus/index.html index 76b48423b..8facd6ae1 100644 --- a/api/category/graphql-markdowndocusaurus/index.html +++ b/api/category/graphql-markdowndocusaurus/index.html @@ -4,10 +4,10 @@ @graphql-markdown/docusaurus | GraphQL-Markdown - - + + -
Skip to main content

@graphql-markdown/docusaurus

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
+
Skip to main content

@graphql-markdown/docusaurus

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/category/graphql-markdowngraphql/index.html b/api/category/graphql-markdowngraphql/index.html index 8af06489b..b12724bd7 100644 --- a/api/category/graphql-markdowngraphql/index.html +++ b/api/category/graphql-markdowngraphql/index.html @@ -4,10 +4,10 @@ @graphql-markdown/graphql | GraphQL-Markdown - - + + -
Skip to main content

@graphql-markdown/graphql

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
+
Skip to main content

@graphql-markdown/graphql

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/category/graphql-markdownhelpers/index.html b/api/category/graphql-markdownhelpers/index.html index 64d850485..22a9d24b3 100644 --- a/api/category/graphql-markdownhelpers/index.html +++ b/api/category/graphql-markdownhelpers/index.html @@ -4,10 +4,10 @@ @graphql-markdown/helpers | GraphQL-Markdown - - + + -
Skip to main content

@graphql-markdown/helpers

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
+
Skip to main content

@graphql-markdown/helpers

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/category/graphql-markdownlogger/index.html b/api/category/graphql-markdownlogger/index.html index 579481361..e456ba09b 100644 --- a/api/category/graphql-markdownlogger/index.html +++ b/api/category/graphql-markdownlogger/index.html @@ -4,10 +4,10 @@ @graphql-markdown/logger | GraphQL-Markdown - - + + -
Skip to main content

@graphql-markdown/logger

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
+
Skip to main content

@graphql-markdown/logger

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/category/graphql-markdownprinter-legacy/index.html b/api/category/graphql-markdownprinter-legacy/index.html index 64baee2fc..61e3e58af 100644 --- a/api/category/graphql-markdownprinter-legacy/index.html +++ b/api/category/graphql-markdownprinter-legacy/index.html @@ -4,10 +4,10 @@ @graphql-markdown/printer-legacy | GraphQL-Markdown - - + + -
Skip to main content

@graphql-markdown/printer-legacy

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
+
Skip to main content

@graphql-markdown/printer-legacy

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/category/graphql-markdowntypes/index.html b/api/category/graphql-markdowntypes/index.html index 0ec3e82bd..62fe5a2a2 100644 --- a/api/category/graphql-markdowntypes/index.html +++ b/api/category/graphql-markdowntypes/index.html @@ -4,10 +4,10 @@ @graphql-markdown/types | GraphQL-Markdown - - + + -
Skip to main content

@graphql-markdown/types

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
+
Skip to main content

@graphql-markdown/types

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/category/graphql-markdownutils/index.html b/api/category/graphql-markdownutils/index.html index 90d939ae1..6c3a1bf27 100644 --- a/api/category/graphql-markdownutils/index.html +++ b/api/category/graphql-markdownutils/index.html @@ -4,10 +4,10 @@ @graphql-markdown/utils | GraphQL-Markdown - - + + -
Skip to main content

@graphql-markdown/utils

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
+
Skip to main content

@graphql-markdown/utils

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/category/graphql/index.html b/api/category/graphql/index.html index 890637e83..e6bd1b54b 100644 --- a/api/category/graphql/index.html +++ b/api/category/graphql/index.html @@ -4,10 +4,10 @@ graphql | GraphQL-Markdown - - + + -
Skip to main content

graphql

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
+
Skip to main content

graphql

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/category/utils/index.html b/api/category/utils/index.html index 9f000b8e0..a3338f7bb 100644 --- a/api/category/utils/index.html +++ b/api/category/utils/index.html @@ -4,10 +4,10 @@ utils | GraphQL-Markdown - - + + -
Skip to main content

utils

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
+
Skip to main content

utils

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/core/config/index.html b/api/core/config/index.html index 93886e40c..e2fa82566 100644 --- a/api/core/config/index.html +++ b/api/core/config/index.html @@ -4,54 +4,54 @@ config | GraphQL-Markdown - - + + -
Skip to main content

config

DeprecatedOption​

+

config

DeprecatedOption​

Enumeration Members​

DEFAULT​

DEFAULT: "default";
-
Source​
+
Defined in​

config.ts:33

GROUP​

GROUP: "group";
-
Source​
+
Defined in​

config.ts:34

SKIP​

SKIP: "skip";
-
Source​
+
Defined in​

config.ts:35

DiffMethod​

Enumeration Members​

FORCE​

FORCE: "FORCE";
-
Source​
+
Defined in​

config.ts:29

NONE​

NONE: "NONE";
-
Source​
+
Defined in​

config.ts:28

ASSET_HOMEPAGE_LOCATION​

const ASSET_HOMEPAGE_LOCATION: string;
-

Source​

+

Defined in​

config.ts:40

DEFAULT_OPTIONS​

const DEFAULT_OPTIONS: Readonly<Pick<ConfigOptions, "customDirective" | "groupByDirective" | "loaders"> & Required<Omit<ConfigOptions, "customDirective" | "groupByDirective" | "loaders">>>;
-

Source​

+

Defined in​

config.ts:47

DOCS_URL​

const DOCS_URL: "https://graphql-markdown.dev/docs";
-

Source​

+

Defined in​

config.ts:38

PACKAGE_NAME​

const PACKAGE_NAME: "@graphql-markdown/docusaurus";
-

Source​

+

Defined in​

config.ts:39

buildConfig()​

@@ -59,10 +59,10 @@

buildConfig()Parameters​

• configFileOpts: Maybe<ConfigOptions>

• cliOpts: Maybe<CliOptions>

-

• id: Maybe<string>= "default"

+

• id: Maybe<string> = "default"

Returns​

Promise<Options>

-

Source​

+

Defined in​

config.ts:330

getCustomDirectives()​

@@ -72,17 +72,17 @@

Parameters• skipDocDirective?: Maybe<DirectiveName[]>

Returns​

Maybe<CustomDirective>

-

Source​

+

Defined in​

config.ts:170

getDiffMethod()​

function getDiffMethod(diff, force): TypeDiffMethod

Parameters​

• diff: TypeDiffMethod

-

• force: boolean= false

+

• force: boolean = false

Returns​

TypeDiffMethod

-

Source​

+

Defined in​

config.ts:203

getDocDirective()​

@@ -91,7 +91,7 @@

Parameters• name: Maybe<DirectiveName>

Returns​

DirectiveName

-

Source​

+

Defined in​

config.ts:86

getDocOptions()​

@@ -101,7 +101,7 @@

Parameters• configOptions?: Maybe<ConfigDocOptions & DeprecatedConfigDocOptions>

Returns​

Required<ConfigDocOptions>

-

Source​

+

Defined in​

config.ts:253

getOnlyDocDirectives()​

@@ -111,7 +111,7 @@

Parameters• configFileOpts: Maybe<Pick<ConfigOptions, "onlyDocDirective">>

Returns​

DirectiveName[]

-

Source​

+

Defined in​

config.ts:102

getPrintTypeOptions()​

@@ -121,7 +121,7 @@

Parameters• configOptions: Maybe<ConfigPrintTypeOptions>

Returns​

Required<ConfigPrintTypeOptions>

-

Source​

+

Defined in​

config.ts:270

getSkipDocDirectives()​

@@ -131,7 +131,7 @@

Parameters• configFileOpts: Maybe<Pick<ConfigOptions, "printTypeOptions" | "skipDocDirective">>

Returns​

DirectiveName[]

-

Source​

+

Defined in​

config.ts:118

getVisibilityDirectives()​

@@ -145,7 +145,7 @@

onlyDocDire 
onlyDocDirective: DirectiveName[];

skipDocDirective​

skipDocDirective: DirectiveName[];
-

Source​

+

Defined in​

config.ts:145

parseDeprecatedDocOptions()​

@@ -161,7 +161,7 @@

pagination_n 
pagination_next: null;

pagination_prev​

pagination_prev: null;
-

Source​

+

Defined in​

config.ts:212

parseGroupByOption()​

@@ -170,7 +170,7 @@

Parameters• groupOptions: unknown

Returns​

Maybe<GroupByDirectiveOptions>

-

Source​

+

Defined in​

config.ts:301

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/core/diff/index.html b/api/core/diff/index.html index 53841105a..f6017d362 100644 --- a/api/core/diff/index.html +++ b/api/core/diff/index.html @@ -4,20 +4,20 @@ diff | GraphQL-Markdown - - + + -

diff

hasChanges()​

+

diff

hasChanges()​

function hasChanges(
   schema, 
   tmpDir, 
   diffMethod, 
diffModule): Promise<boolean>

Parameters​

• schema: GraphQLSchema

• tmpDir: string

• diffMethod: Maybe<DiffMethodName>

-

• diffModule: Maybe<string>= "@graphql-markdown/diff"

+

• diffModule: Maybe<string> = "@graphql-markdown/diff"

Returns​

Promise<boolean>

-

Source​

+

Defined in​

diff.ts:10

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/core/generator/index.html b/api/core/generator/index.html index abb1c5e68..bba3d4a3f 100644 --- a/api/core/generator/index.html +++ b/api/core/generator/index.html @@ -4,17 +4,17 @@ generator | GraphQL-Markdown - - + + -

generator

generateDocFromSchema()​

+

generator

generateDocFromSchema()​

function generateDocFromSchema(__namedParameters): Promise<void>

Parameters​

• __namedParameters: GeneratorOptions

Returns​

Promise<void>

-

Source​

+

Defined in​

generator.ts:28

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/core/graphql-config/index.html b/api/core/graphql-config/index.html index 8ccd4340d..7af10d747 100644 --- a/api/core/graphql-config/index.html +++ b/api/core/graphql-config/index.html @@ -4,18 +4,18 @@ graphql-config | GraphQL-Markdown - - + + -

graphql-config

EXTENSION_NAME​

+

graphql-config

EXTENSION_NAME​

const EXTENSION_NAME: "graphql-markdown";
-

Source​

+

Defined in​

graphql-config.ts:13

graphQLConfigExtension​

const graphQLConfigExtension: GraphQLExtensionDeclaration;
-

Source​

+

Defined in​

graphql-config.ts:14

loadConfiguration()​

@@ -23,10 +23,10 @@

loadConfig

Parameters​

• id: Maybe<string>

• options?: Maybe<PackageOptionsConfig>

-

• __namedParameters?: ThrowOptions= undefined

+

• __namedParameters?: ThrowOptions = ...

Returns​

Promise<Maybe<Readonly<ExtensionProjectConfig>>>

-

Source​

+

Defined in​

graphql-config.ts:43

setLoaderOptions()​

@@ -36,7 +36,7 @@

Parameters• options: PackageOptionsConfig

Returns​

LoaderOption

-

Source​

+

Defined in​

graphql-config.ts:23

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/core/printer/index.html b/api/core/printer/index.html index a6e11b61c..8d63e75a8 100644 --- a/api/core/printer/index.html +++ b/api/core/printer/index.html @@ -4,11 +4,11 @@ printer | GraphQL-Markdown - - + + -

printer

getPrinter()​

+
Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/core/renderer/index.html b/api/core/renderer/index.html index 7f0eb2f55..8246e5470 100644 --- a/api/core/renderer/index.html +++ b/api/core/renderer/index.html @@ -4,11 +4,11 @@ renderer | GraphQL-Markdown - - + + -

renderer

Renderer​

+

renderer

Renderer​

Constructors​

new Renderer()​

new Renderer(
   printer, 
   outputDir, 
   baseURL, 
   group, 
   prettify, 
   docOptions): Renderer
@@ -21,28 +21,28 @@
Parameters• docOptions: Maybe<RendererDocOptions>

Returns​

Renderer

-
Source​
+
Defined in​

renderer.ts:47

Properties​

baseURL​

baseURL: string;
-
Source​
+
Defined in​

renderer.ts:41

group​

group: Maybe<Partial<Record<SchemaEntity, Record<string, Maybe<string>>>>>;
-
Source​
+
Defined in​

renderer.ts:39

options​

options: Maybe<RendererDocOptions>;
-
Source​
+
Defined in​

renderer.ts:43

outputDir​

outputDir: string;
-
Source​
+
Defined in​

renderer.ts:40

prettify​

prettify: boolean;
-
Source​
+
Defined in​

renderer.ts:42

Methods​

generateCategoryMetafile()​

@@ -52,12 +52,12 @@
Parameters• dirPath: string

• sidebarPosition?: number

• styleClass?: string

-

• options?= undefined

+

• options? = ...

• options.collapsed?: boolean

• options.collapsible?: boolean

Returns​

Promise<void>

-
Source​
+
Defined in​

renderer.ts:63

generateCategoryMetafileType()​

generateCategoryMetafileType(
   type, 
   name, 
rootTypeName): Promise<string>
@@ -67,7 +67,7 @@
Parameters• rootTypeName: SchemaEntity

Returns​

Promise<string>

-
Source​
+
Defined in​

renderer.ts:98

renderHomepage()​

renderHomepage(homepageLocation): Promise<void>
@@ -75,7 +75,7 @@
Parameters• homepageLocation: string

Returns​

Promise<void>

-
Source​
+
Defined in​

renderer.ts:248

renderRootTypes()​

renderRootTypes(rootTypeName, type): Promise<Maybe<Maybe<Category>[]>>
@@ -84,13 +84,13 @@
Parameters• type: unknown

Returns​

Promise<Maybe<Maybe<Category>[]>>

-
Source​
+
Defined in​

renderer.ts:145

renderSidebar()​

renderSidebar(): Promise<string>
Returns​

Promise<string>

-
Source​
+
Defined in​

renderer.ts:222

renderTypeEntities()​

renderTypeEntities(
   dirPath, 
   name, 
type): Promise<Maybe<Category>>
@@ -100,7 +100,7 @@
Parameters• type: unknown

Returns​

Promise<Maybe<Category>>

-
Source​
+
Defined in​

renderer.ts:174

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/diff/globals/index.html b/api/diff/globals/index.html index c366fb9d3..994e1f291 100644 --- a/api/diff/globals/index.html +++ b/api/diff/globals/index.html @@ -4,10 +4,10 @@ diff | GraphQL-Markdown - - + + -
Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
+
Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/docusaurus/globals/index.html b/api/docusaurus/globals/index.html index 1c807c87f..f40176ee7 100644 --- a/api/docusaurus/globals/index.html +++ b/api/docusaurus/globals/index.html @@ -4,10 +4,10 @@ docusaurus | GraphQL-Markdown - - + + -
Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
+
Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/graphql/directive/index.html b/api/graphql/directive/index.html index 4ca556bef..68828d607 100644 --- a/api/graphql/directive/index.html +++ b/api/graphql/directive/index.html @@ -4,18 +4,18 @@ directive | GraphQL-Markdown - - + + -

directive

Library supporting customDirective for directive based customization.

+

directive

Library supporting customDirective for directive based customization.

See​

Option customDirective

WILDCARD_DIRECTIVE​

const WILDCARD_DIRECTIVE: "*";

Wildcard * character for matching any directive name.

See getCustomDirectiveOptions, isCustomDirective

-

Source​

+

Defined in​

packages/graphql/src/directive.ts:30

executableDirectiveLocation()​

@@ -25,12 +25,11 @@

Parameters• directive: GraphQLDirective

Returns​

boolean

-

Source​

+

Defined in​

packages/graphql/src/directive.ts:285

getConstDirectiveMap()​

function getConstDirectiveMap(entity, customDirectiveMap): Maybe<CustomDirectiveMap>
-

Returns a map of custom directives for a schema entity.

Parameters​

• entity: unknown

a GraphQL schema entity.

@@ -39,14 +38,11 @@

ParametersReturns​

Maybe<CustomDirectiveMap>

a map of GraphQL directives matching the custom directives defined, else undefined.

-

Example​

-
import { buildSchema } from "graphql";
import { getConstDirectiveMap } from "@graphql-markdown/utils/directive";

const schema = buildSchema(`
    directive @testA(
      arg: ArgEnum = ARGA
    ) on OBJECT | FIELD_DEFINITION

    directive @testB(
      argA: Int!,
      argB: [String!]
    ) on FIELD_DEFINITION

    enum ArgEnum {
      ARGA
      ARGB
      ARGC
    }

    type Test @testA {
      id: ID!
      fieldA: [String!]
        @testA(arg: ARGC)
        @testB(argA: 10, argB: ["testArgB"])
    }

    type TestWithoutDirective {
      id: ID!
    }
  `);

const customDirectives = {
  testA: {
    type: schema.getDirective("testA"),
    descriptor: (_, constDirectiveType) => `${constDirectiveType.name}`;
  },
};

const map = getConstDirectiveMap(schema.getType("Test"), customDirectives);
// Expected result: {
//   "descriptor": (_, constDirectiveType) => `${constDirectiveType.name}`,
//   "type": schema.getDirective("testA"),
// }

-

Source​

+

Defined in​

packages/graphql/src/directive.ts:250

getCustomDirectiveOptions()​

function getCustomDirectiveOptions(schemaDirectiveName, customDirectiveOptions): Maybe<CustomDirectiveOptions>
-

Returns a record set of custom handlers from a directive by name.

Parameters​

• schemaDirectiveName: DirectiveName

the GraphQL directive name.

@@ -55,14 +51,11 @@

ParametersReturns​

Maybe<CustomDirectiveOptions>

a record set of custom handlers for the matching directive (or if * is declared), or undefined if no match.

-

Example​

-
import { getCustomDirectiveOptions } from "@graphql-markdown/utils/directive";

const customDirectiveOptions = {
  "*": {
    descriptor: (_, constDirectiveType) => `Wildcard ${constDirectiveType.name}`;
  },
};

const customDirectives = getCustomDirectiveOptions("testB", customDirectiveOptions);

// Expected result: {
//   "descriptor": (_, constDirectiveType) => `Wildcard ${constDirectiveType.name}`,
//   "type": "@testB",
// }
-

Source​

+

Defined in​

packages/graphql/src/directive.ts:78

getCustomDirectives()​

function getCustomDirectives(schemaMap, customDirectiveOptions?): Maybe<CustomDirectiveMap>
-

Returns a custom directives map with custom handlers from customDirective.

Parameters​

• schemaMap: Pick<SchemaMap, "directives">

the GraphQL schema map returned by introspection!getSchemaMap

@@ -71,14 +64,11 @@

ParametersReturns​

Maybe<CustomDirectiveMap>

a custom directive map, or undefined if no match.

-

Example​

-
import { buildSchema } from "graphql";
import { getCustomDirectives } from "@graphql-markdown/utils/directive";

const schema = buildSchema(`
  directive @testA(
    arg: ArgEnum = ARGA
  ) on OBJECT | FIELD_DEFINITION
  directive @testB(
    argA: Int!,
    argB: [String!]
  ) on FIELD_DEFINITION
  enum ArgEnum {
    ARGA
    ARGB
    ARGC
  }
`);

const schemaMap = {
  directives: {
    testA: schema.getDirective("testA"),
    testB: schema.getDirective("testB"),
  },
};

const customDirectiveOptions = {
  testA: {
    descriptor: (_, constDirectiveType) => `Named directive ${constDirectiveType.name}`;
  },
  "*": {
    descriptor: (_, constDirectiveType) => `Wildcard ${constDirectiveType.name}`;
  },
};

const customDirectives = getCustomDirectives(schemaMap, customDirectiveOptions);

// Expected result: {
//   "testA": {
//     "descriptor": (_, constDirectiveType) => `Named directive ${constDirectiveType.name}`,
//     "type": "@testA",
//   },
//   "testB": {
//     "descriptor": (_, constDirectiveType) => `Wildcard ${constDirectiveType.name}`,
//     "type": "@testB",
//   },
// }
-

Source​

+

Defined in​

packages/graphql/src/directive.ts:152

isCustomDirective()​

function isCustomDirective(schemaDirectiveName, customDirectiveOptions): boolean
-

Checks if a directive name is referenced in customDirective option.

Parameters​

• schemaDirectiveName: DirectiveName

the GraphQL directive name.

@@ -87,7 +77,7 @@

ParametersReturns​

boolean

true if the directive is declared or * is declared in customDirective option, else false.

-

Source​

+

Defined in​

packages/graphql/src/directive.ts:41

typeSystemDirectiveLocation()​

@@ -97,7 +87,7 @@

Parameters• directive: GraphQLDirective

Returns​

boolean

-

Source​

+

Defined in​

packages/graphql/src/directive.ts:308

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/graphql/formatter/index.html b/api/graphql/formatter/index.html index e33de2cf8..2fb2d461c 100644 --- a/api/graphql/formatter/index.html +++ b/api/graphql/formatter/index.html @@ -4,16 +4,14 @@ formatter | GraphQL-Markdown - - + + -

formatter

Internal library of helpers for formatting GraphQL values.

+

formatter

Internal library of helpers for formatting GraphQL values.

getFormattedDefaultValue()​

function getFormattedDefaultValue<T>(entity): Maybe<string | T>
-

Returns a printable formatted value for a GraphQL type. -This is the generic function.

-

Type parameters​

+

Type Parameters​

• T

Parameters​

• entity

@@ -25,7 +23,7 @@

ParametersReturns​

Maybe<string | T>

a printable formatted value.

-

Source​

+

Defined in​

packages/graphql/src/formatter.ts:94

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/graphql/group/index.html b/api/graphql/group/index.html index 5c05d23f0..406e6aa85 100644 --- a/api/graphql/group/index.html +++ b/api/graphql/group/index.html @@ -4,17 +4,16 @@ group | GraphQL-Markdown - - + + -

group

Library supporting groupByDirective for grouping GraphQL schema entities.

+

group

Library supporting groupByDirective for grouping GraphQL schema entities.

See​

Option groupByDirective

getGroupName()​

function getGroupName<T>(type, groupByDirective): Maybe<string>
-

Gets the group name for a schema type based on the directive information.

-

Type parameters​

+

Type Parameters​

• T

Parameters​

• type: T

@@ -24,14 +23,11 @@

ParametersReturns​

Maybe<string>

the group name matching the type, or groupByDirective.fallback if no match found.

-

Example​

-
import { buildSchema } from "graphql";
import { getGroupName } from "@graphql-markdown/utils/groups";

const schema = buildSchema(`
  directive @doc(
    category: String
  ) on OBJECT | INPUT_OBJECT | UNION | ENUM | INTERFACE | FIELD_DEFINITION | ARGUMENT_DEFINITION
  type Unicorn {
    name: String!
  }
  type Bird @doc(category: "animal") {
    name: String!
  }
  type Fish {
    name: String!
  }
  type Elf @doc(category: "fantasy") {
    name: String!
  }
  type Query {
    Fish: [Fish!]! @doc(category: "animal")
  }
`);

const groupOptions = {
  fallback: "common",
  directive: "doc",
  field: "category",
}

getGroupName(schema.getType("Bird"), groupOptions); // Expected result: "animal"

getGroupName(schema.getType("Unicorn"), groupOptions); // Expected result: "common"

-

Source​

+

Defined in​

packages/graphql/src/group.ts:72

getGroups()​

function getGroups(schemaMap, groupByDirective): Maybe<Partial<Record<SchemaEntity, Record<string, Maybe<string>>>>>
-

Parses a GraphQL schema to build a map of entities with matching groupByDirective option.

Parameters​

• schemaMap: SchemaMap

the GraphQL schema map returned by introspection!getSchemaMap

@@ -40,9 +36,7 @@

ParametersReturns​

Maybe<Partial<Record<SchemaEntity, Record<string, Maybe<string>>>>>

a map of entities with matching group name.

-

Example​

-
import { buildSchema } from "graphql";
import { getGroups } from "@graphql-markdown/utils/groups";

const schema = buildSchema(`
  directive @doc(
    category: String
  ) on OBJECT | INPUT_OBJECT | UNION | ENUM | INTERFACE | FIELD_DEFINITION | ARGUMENT_DEFINITION
  type Unicorn {
    name: String!
  }
  type Bird @doc(category: "animal") {
    name: String!
  }
  type Fish {
    name: String!
  }
  type Elf @doc(category: "fantasy") {
    name: String!
  }
  type Query {
    Fish: [Fish!]! @doc(category: "animal")
  }
`);

const schemaMap = {
  objects: schema.getTypeMap(),
  queries: schema.getQueryType()?.getFields(),
};

const groupOptions = {
  fallback: "common",
  directive: "doc",
  field: "category",
}

const groupsMap = getGroups(schemaMap, groupOptions);

// Expected result: {
//   "objects": {
//     "Bird": "animal",
//     "Boolean": "common",
//     "Elf": "fantasy",
//     "Fish": "common",
//     "Query": "common",
//     "String": "common",
//     "Unicorn": "common",
//   },
//   "queries": {
//     "Fish": "animal",
//   },
// }
-

Source​

+

Defined in​

packages/graphql/src/group.ts:173

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/graphql/guard/index.html b/api/graphql/guard/index.html index b003f3fbc..7ca5dbc5c 100644 --- a/api/graphql/guard/index.html +++ b/api/graphql/guard/index.html @@ -4,15 +4,15 @@ guard | GraphQL-Markdown - - + + -

guard

Custom GraphQL type guards and property guards.

+

guard

Custom GraphQL type guards and property guards.

instanceOf()​

function instanceOf<T>(obj, type): obj is T

Checks if a GraphQL named type is of generic type T.

-

Type parameters​

+

Type Parameters​

• T

a GraphQL type to check against, eg GraphQLObjectType.

Parameters​

@@ -22,7 +22,7 @@

Parametersthe GraphQL type T.

Returns​

obj is T

-

Source​

+

Defined in​

packages/graphql/src/guard.ts:57

isApiType()​

@@ -33,13 +33,13 @@

Parametersa GraphQL type.

Returns​

boolean

-

Source​

+

Defined in​

packages/graphql/src/guard.ts:100

isDeprecated()​

function isDeprecated<T>(obj): obj is DeprecatedType<T>

Checks if a GraphQL named type is deprecated.

-

Type parameters​

+

Type Parameters​

• T

a GraphQL type to check against, eg GraphQLObjectType.

Parameters​

@@ -47,7 +47,7 @@

Parametersan instance of T.

Returns​

obj is DeprecatedType<T>

-

Source​

+

Defined in​

packages/graphql/src/guard.ts:75

isGraphQLFieldType()​

@@ -58,7 +58,7 @@

Parametersa GraphQL type.

Returns​

type is GraphQLField<unknown, unknown, unknown>

-

Source​

+

Defined in​

packages/graphql/src/guard.ts:38

isOperation()​

@@ -69,7 +69,7 @@

Parametersa GraphQL type.

Returns​

type is GraphQLOperationType

-

Source​

+

Defined in​

packages/graphql/src/guard.ts:90

isSystemType()​

@@ -80,7 +80,7 @@

Parametersa GraphQL type.

Returns​

boolean

-

Source​

+

Defined in​

packages/graphql/src/guard.ts:113

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/graphql/introspection/index.html b/api/graphql/introspection/index.html index 742f474ad..47117b622 100644 --- a/api/graphql/introspection/index.html +++ b/api/graphql/introspection/index.html @@ -4,11 +4,11 @@ introspection | GraphQL-Markdown - - + + -

introspection

Library for introspecting a GraphQL schema. +

introspection

Library for introspecting a GraphQL schema. The entry point method is getSchemaMap.

IntrospectionError​

Extends​

@@ -24,7 +24,7 @@
ReturnsIntrospectionError

Inherited from​

Error.constructor

-
Source​
+
Defined in​

node_modules/typescript/lib/lib.es5.d.ts:1082

new IntrospectionError()​

new IntrospectionError(message?, options?): IntrospectionError
@@ -35,15 +35,12 @@
ReturnsIntrospectionError

Inherited from​

Error.constructor

-
Source​
+
Defined in​

node_modules/typescript/lib/lib.es5.d.ts:1082

_getFields()​

-

Internal

function _getFields<T, V>(
   type, 
   processor?, 
   fallback?): GraphQLObjectType<any, any> | GraphQLFieldMap<unknown, unknown> | GraphQLInputFieldMap | V
-

Returns the fields from a GraphQL schema type.

-

see getOperation, getFields

-

Type parameters​

+

Type Parameters​

• T

• V

Parameters​

@@ -56,12 +53,11 @@

ParametersReturns​

GraphQLObjectType<any, any> | GraphQLFieldMap<unknown, unknown> | GraphQLInputFieldMap | V

a map of fields as k/v records, or fallback value if no fields available.

-

Source​

+

Defined in​

packages/graphql/src/introspection.ts:317

getDirective()​

function getDirective(entity, directives): GraphQLDirective[]
-

Returns a schema entity's list of directives matching a defined set.

Parameters​

• entity: unknown

a GraphQL schema entity.

@@ -70,7 +66,7 @@

ParametersReturns​

GraphQLDirective[]

a list of GraphQL directives matching the set, else false.

-

Source​

+

Defined in​

packages/graphql/src/introspection.ts:226

getDirectiveLocationForASTPath()​

@@ -79,55 +75,44 @@

Parameters• appliedTo: any

Returns​

DirectiveLocation

-

Source​

+

Defined in​

packages/graphql/src/introspection.ts:113

getFields()​

function getFields(type): unknown[]
-

Returns fields map for a GraphQL schema type.

-

see getSchemaMap

Parameters​

• type: unknown

the GraphQL schema type to parse.

Returns​

unknown[]

a list of fields of type object.

-

Source​

+

Defined in​

packages/graphql/src/introspection.ts:386

getOperation()​

-

Internal

function getOperation(operationType?): Record<string, GraphQLOperationType>
-

Returns fields map for a GraphQL operation type (query, mutation, subscription...).

-

see getSchemaMap

Parameters​

• operationType?: unknown

the operation type to parse.

Returns​

Record<string, GraphQLOperationType>

a map of fields as k/v records.

-

Source​

+

Defined in​

packages/graphql/src/introspection.ts:362

getSchemaMap()​

function getSchemaMap(schema): SchemaMap
-

Returns an introspection map of the GraphQL schema. -This is the entry point for GraphQL-Markdown schema parsing features.

Parameters​

• schema: Maybe<GraphQLSchema>

a GraphQL schema.

Returns​

SchemaMap

a schema map by GraphQL entities (see SchemaEntity).

-

Example​

-
import { buildSchema } from "graphql";
import { getSchemaMap } from "@graphql-markdown/utils/graphql";

const schema = buildSchema(`
  interface Record {
    id: String!
  }
  type StudyItem implements Record {
    id: String!
    subject: String!
    duration: Int!
  }
  type Query {
    getStudyItems(subject: String): [StudyItem!]
    getStudyItem(id: String!): StudyItem
  }
  type Mutation {
    addStudyItem(subject: String!, duration: Int!): StudyItem
  }
  type Subscription {
    listStudyItems: [StudyItem!]
  }
`);

const schemaTypeMap = getSchemaMap(schema);

// expected result: {
//   queries: {
//     getStudyItems: GraphQLField,
//     getStudyItem: GraphQLField,
//   },
//   mutations: {
//     addStudyItem: GraphQLField,
//   },
//   subscriptions: {
//     listStudyItems: GraphQLField,
//   }
//   directives: {
//     include: GraphQLDirective,
//     skip: GraphQLDirective,
//     deprecated: GraphQLDirective,
//     specifiedBy: GraphQLDirective,
//   objects: {
//     StudyItem: GraphQLObjectType,
//   unions: {},
//   interfaces: {
//     Record: GraphQLInterfaceType,
//   enums: {},
//   inputs: {},
//   scalars: {
//     String: GraphQLScalarType,
//     Int: GraphQLScalarType,
//     Boolean: GraphQLScalarType,
//   }
// }
-

Source​

+

Defined in​

packages/graphql/src/introspection.ts:496

getTypeDirectiveArgValue()​

function getTypeDirectiveArgValue(
   directive, 
   node, 
argName): Maybe<string | Record<string, unknown>>
-

Returns one directive's argument's value linked to a GraphQL schema type. -It calls getTypeDirectiveValues and returns a matching record.

Parameters​

• directive: GraphQLDirective

a GraphQL directive defined in the schema.

@@ -137,12 +122,11 @@

ParametersReturns​

Maybe<string | Record<string, unknown>>

a record k/v with argName as key and the argument's value.

-

Source​

+

Defined in​

packages/graphql/src/introspection.ts:289

getTypeDirectiveValues()​

function getTypeDirectiveValues(directive, type): Maybe<Record<string, unknown>>
-

Returns all directive's arguments' values linked to a GraphQL schema type.

Parameters​

• directive: GraphQLDirective

a GraphQL directive defined in the schema.

@@ -151,15 +135,12 @@

ParametersReturns​

Maybe<Record<string, unknown>>

a record k/v with arguments' name as keys and arguments' value.

-

Source​

+

Defined in​

packages/graphql/src/introspection.ts:258

getTypeFromSchema()​

-

Internal

function getTypeFromSchema<T>(schema, type): Maybe<Record<string, T>>
-

Returns a map of GraphQL named types from a schema for a defined GraphQL type. -When parsing the entities, internal GraphQL entities (starting with __) are excluded.

-

Type parameters​

+

Type Parameters​

• T

Parameters​

• schema: Maybe<GraphQLSchema>

@@ -169,29 +150,24 @@

ParametersReturns​

Maybe<Record<string, T>>

a map of GraphQL named types for the matching GraphQL type, or undefined if no match.

-

See​

-

getSchemaMap

-

Source​

+

Defined in​

packages/graphql/src/introspection.ts:61

getTypeName()​

function getTypeName(type, defaultName): string
-

Resolves the name of a GraphQL schema type.

Parameters​

• type: unknown

-

• defaultName: string= ""

+

• defaultName: string = ""

optional fallback value if the name resolution fails.

Returns​

string

the type's name, or defaultName.

-

Source​

+

Defined in​

packages/graphql/src/introspection.ts:409

hasAstNode()​

-

Internal

function hasAstNode<T>(node): node is AstNodeType<T>
-

Type guard for type with an AST node property.

-

Type parameters​

+

Type Parameters​

• T

Parameters​

• node: T

@@ -199,28 +175,26 @@

ParametersReturns​

node is AstNodeType<T>

true if the entity has an AST node property, else false.

-

Source​

+

Defined in​

packages/graphql/src/introspection.ts:109

hasDirective()​

function hasDirective(
   entity, 
   directives, 
   fallback): boolean
-

Checks if a schema entity as a directive belonging to a defined set.

Parameters​

• entity: unknown

a GraphQL schema entity.

• directives: Maybe<GraphQLDirective[]>

a directive name or a list of directive names.

-

• fallback: boolean= false

+

• fallback: boolean = false

default value if the entity type is not a valid location for directives.

Returns​

boolean

true if the entity has at least one directive matching, else false.

-

Source​

+

Defined in​

packages/graphql/src/introspection.ts:188

isValidDirectiveLocation()​

function isValidDirectiveLocation(entity, directive): boolean
-

Check if a directive can be applied to specific schema entity location.

Parameters​

• entity: unknown

a GraphQL schema entity.

@@ -229,7 +203,7 @@

ParametersReturns​

boolean

true if the entity is a valid directive location, else false.

-

Source​

+

Defined in​

packages/graphql/src/introspection.ts:167

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/graphql/loader/index.html b/api/graphql/loader/index.html index e45b96a98..a22a319cf 100644 --- a/api/graphql/loader/index.html +++ b/api/graphql/loader/index.html @@ -4,33 +4,24 @@ loader | GraphQL-Markdown - - + + -

loader

Library for GraphQL schema loading and loaders config processing.

+

loader

Library for GraphQL schema loading and loaders config processing.

getDocumentLoaders()​

function getDocumentLoaders(loadersList): Promise<Maybe<LoadSchemaOptions>>
-

Asynchronously returns a valid loaders list for loadSchema based on the plugin config. -Import each loader package, and instantiate a loader object.

Parameters​

• loadersList: Maybe<LoaderOption>

the list of loaders defined in the plugin config.

Returns​

Promise<Maybe<LoadSchemaOptions>>

a list of loader objects.

-

Throws​

-

an Error if no loader has been loaded, or if an error occurred while importing loaders.

-

Example​

-
import { getDocumentLoaders, loadSchema } from "@graphql-markdown/utils/graphql"

const loaderList = {
  GraphQLFileLoader: "@graphql-tools/graphql-file-loader",
};

const loaders = await getDocumentLoaders(loaderList);

const schema = await loadSchema("schema.graphql", {
  loaders,
  rootTypes: { query: "Root", subscription: "" },
});
-

Source​

+

Defined in​

packages/graphql/src/loader.ts:106

loadSchema()​

function loadSchema(schemaLocation, options): Promise<GraphQLSchema>
-

Wrapper method for @graphql-tools/load.loadSchema to load asynchronously a GraphQL Schema from a source. -The wrapper will load the schema using the loader declared in options. -If rootTypes is set in the options, then the schema root types will be overridden to generate custom GraphQL schema.

Parameters​

• schemaLocation: string

the schema location pointer matching the loader.

@@ -39,9 +30,7 @@

ParametersReturns​

Promise<GraphQLSchema>

a GraphQL schema.

-

Example​

-
import { loadSchema } from "@graphql-markdown/utils/graphql"

const schema = await loadSchema("schema.graphql", {
  loaders: [new GraphQLFileLoader()],
  rootTypes: { query: "Root", subscription: "" },
});
-

Source​

+

Defined in​

packages/graphql/src/loader.ts:41

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/graphql/relation/index.html b/api/graphql/relation/index.html index 4450920a8..23ae71716 100644 --- a/api/graphql/relation/index.html +++ b/api/graphql/relation/index.html @@ -4,16 +4,15 @@ relation | GraphQL-Markdown - - + + -

relation

Library supporting relatedTypeSection for displaying relations between GraphQL schema entities.

+

relation

Library supporting relatedTypeSection for displaying relations between GraphQL schema entities.

See​

Option relatedTypeSection

getRelationOfField()​

function getRelationOfField(type, schemaMap): Partial<Record<SchemaEntity, RelationOfField[]>>
-

Returns a map of fields and arguments where the GraphQL schema type matches the type.

Parameters​

• type: unknown

the GraphQL schema type being processed.

@@ -22,14 +21,11 @@

ParametersReturns​

Partial<Record<SchemaEntity, RelationOfField[]>>

a record map of fields and arguments relations.

-

See​

-

mapRelationOf

-

Source​

+

Defined in​

packages/graphql/src/relation.ts:165

getRelationOfImplementation()​

function getRelationOfImplementation(type, schemaMap): Partial<Record<SchemaEntity, RelationOfImplementation[]>>
-

Returns a map of types (unions or interfaces) where the GraphQL schema type is implemented.

Parameters​

• type: unknown

the GraphQL schema type being processed.

@@ -38,14 +34,11 @@

ParametersReturns​

Partial<Record<SchemaEntity, RelationOfImplementation[]>>

a record map of unions or interfaces relations.

-

See​

-

mapRelationOf

-

Source​

+

Defined in​

packages/graphql/src/relation.ts:351

getRelationOfInterface()​

function getRelationOfInterface(type, schemaMap): Partial<Record<SchemaEntity, RelationOfInterface[]>>
-

Returns a map of interfaces where the GraphQL schema type is extended.

Parameters​

• type: unknown

the GraphQL schema type being processed.

@@ -54,14 +47,11 @@

ParametersReturns​

Partial<Record<SchemaEntity, RelationOfInterface[]>>

a record map of interfaces relations.

-

See​

-

mapRelationOf

-

Source​

+

Defined in​

packages/graphql/src/relation.ts:294

getRelationOfReturn()​

function getRelationOfReturn(type, schemaMap): Partial<Record<SchemaEntity, GraphQLOperationType[]>>
-

Returns a map of operations (queries, mutations, subscriptions) where the GraphQL schema type is the return type.

Parameters​

• type: unknown

the GraphQL schema type being processed.

@@ -70,14 +60,11 @@

ParametersReturns​

Partial<Record<SchemaEntity, GraphQLOperationType[]>>

a record map of operations relations.

-

See​

-

mapRelationOf

-

Source​

+

Defined in​

packages/graphql/src/relation.ts:104

getRelationOfUnion()​

function getRelationOfUnion(type, schemaMap): Partial<Record<SchemaEntity, GraphQLUnionType[]>>
-

Returns a map of unions where the GraphQL schema type is part of it.

Parameters​

• type: unknown

the GraphQL schema type being processed.

@@ -86,9 +73,7 @@

ParametersReturns​

Partial<Record<SchemaEntity, GraphQLUnionType[]>>

a record map of unions relations.

-

See​

-

mapRelationOf

-

Source​

+

Defined in​

packages/graphql/src/relation.ts:238

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/helpers/directives/descriptor/index.html b/api/helpers/directives/descriptor/index.html index 1d9aca80b..3cc3f3d22 100644 --- a/api/helpers/directives/descriptor/index.html +++ b/api/helpers/directives/descriptor/index.html @@ -4,11 +4,11 @@ descriptor | GraphQL-Markdown - - + + -

descriptor

Custom directive descriptor helper.

+

descriptor

Custom directive descriptor helper.

See​

Option customDirective.[directive].descriptor

directiveDescriptor()​

@@ -27,7 +27,7 @@

ReturnsExample​

import { GraphQLDirective, GraphQLScalarType } from "graphql";
import { directiveDescriptor } from "@graphql-markdown/helpers/directives/descriptor";

const directive = new GraphQLDirective({
  name: "version",
  description: "Min version",
  locations: [],
  args: {
    major: { type: GraphQLInt, defaultValue: 0 },
    minor: { type: GraphQLInt, defaultValue: 0 },
    patch: { type: GraphQLInt, defaultValue: 0 },
  },
});

const type = new GraphQLScalarType<string>({
  name: "FooBar",
  astNode: {
    kind: Kind.SCALAR_TYPE_DEFINITION,
    name: { kind: Kind.NAME, value: "FooBar" },
    directives: [
      {
        kind: Kind.DIRECTIVE,
        name: { kind: Kind.NAME, value: "version" },
        arguments: [
          {
            kind: Kind.ARGUMENT,
            name: { kind: Kind.NAME, value: "major" },
            value: { kind: Kind.INT, value: "2" },
          },
          {
            kind: Kind.ARGUMENT,
            name: { kind: Kind.NAME, value: "minor" },
            value: { kind: Kind.INT, value: "1" },
          },
          {
            kind: Kind.ARGUMENT,
            name: { kind: Kind.NAME, value: "patch" },
            value: { kind: Kind.INT, value: "3" },
          },
        ],
      },
    ],
  },
});

directiveDescriptor(directive, type, "${description} is ${major}.${minor}.${patch}");
// Expected result: "Min version is 2.1.3"

directiveDescriptor(directive, type);
// Expected result: "Min version"

directiveDescriptor(directive, type, "Version should be at least ^${major}.${minor}.${patch}");
// Expected result: "Version should be at least ^2.1.3"
-

Source​

+

Defined in​

directives/descriptor.ts:83

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/helpers/directives/tag/index.html b/api/helpers/directives/tag/index.html index 328941e1b..86016aad2 100644 --- a/api/helpers/directives/tag/index.html +++ b/api/helpers/directives/tag/index.html @@ -4,11 +4,11 @@ tag | GraphQL-Markdown - - + + -

tag

Custom directive tag helper.

+

tag

Custom directive tag helper.

See​

Option customDirective.[directive].tag

directiveTag()​

@@ -20,14 +20,14 @@

Parametersthe schema directive to parse.

• type?: unknown

the type being processed.

-

• classname?: string= "badge--secondary"

+

• classname?: string = "badge--secondary"

optional CSS classname, "badge--secondary" by default.

Returns​

Badge

a custom description based on directive value.

Example​

import { GraphQLDirective, GraphQLScalarType } from "graphql";
import { directiveTag } from "@graphql-markdown/helpers/directives/tag";

const directive = new GraphQLDirective({
  name: "auth",
  description: "Authentication required",
  locations: [],
});

const type = new GraphQLScalarType<string>({
  name: "FooBar",
  astNode: {
    kind: Kind.SCALAR_TYPE_DEFINITION,
    name: { kind: Kind.NAME, value: "FooBar" },
    directives: [
      {
        kind: Kind.DIRECTIVE,
        name: { kind: Kind.NAME, value: "auth" },
      },
    ],
  },
});

directiveTag(directive, type);
// Expected result: { text: "@auth", classname: "badge--secondary" }
-

Source​

+

Defined in​

directives/tag.ts:51

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/helpers/utils/interpolate/index.html b/api/helpers/utils/interpolate/index.html index 900b30946..4743c5005 100644 --- a/api/helpers/utils/interpolate/index.html +++ b/api/helpers/utils/interpolate/index.html @@ -4,28 +4,28 @@ interpolate | GraphQL-Markdown - - + + -

interpolate

Helpers utility functions library.

+

interpolate

Helpers utility functions library.

getObjPath()​

-

Internal

function getObjPath(
   path, 
   obj, 
   fallback): unknown
+

Internal

Returns the value of the specified property or nested property of an object using a string path.

Parameters​

• path: Maybe<string>

property path as string.

• obj: unknown

the key/value record object.

-

• fallback: unknown= ""

+

• fallback: unknown = ""

optional fallback value to be returned if the path cannot be resolved.

Returns​

unknown

the property value if the path is resolved, else returns the fallback value.

Example​

import { getObjPath } from '@graphql-markdown/utils/object';

getObjPath("foo.bar", { foo: { bar: 42 } }); // Returns 42

getObjPath("foo.bak", { foo: { bar: 42 } }, "fallback"); // Returns "fallback"
-

Source​

+

Defined in​

utils/interpolate.ts:31

interpolate()​

@@ -43,7 +43,7 @@

ReturnsExample​

const values = { foo: 42, bar: { value: "test" } };
const template = "${foo} is not ${bar.notfound}";

interpolate(template, values, "fallback"); // Expected result: "42 is not fallback",
-

Source​

+

Defined in​

utils/interpolate.ts:64

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/index.html b/api/index.html index b91ddae7c..855ec8823 100644 --- a/api/index.html +++ b/api/index.html @@ -4,11 +4,11 @@ API | GraphQL-Markdown - - + + -

API

+

API

This section is a work in progress documentation of the GraphQL-Markdown API for NodeJS. For more details about each individual modules, refer to the packages API docs. It is intended primarily for those interested in contributing to the GraphQL-Markdown codebase or developing a custom doc generator.

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/logger/globals/index.html b/api/logger/globals/index.html index 0b25691e8..653a7a946 100644 --- a/api/logger/globals/index.html +++ b/api/logger/globals/index.html @@ -4,10 +4,10 @@ logger | GraphQL-Markdown - - + + -
Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
+
Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/badge/index.html b/api/printer-legacy/badge/index.html index 6f11fe9dc..923a72c1e 100644 --- a/api/printer-legacy/badge/index.html +++ b/api/printer-legacy/badge/index.html @@ -4,13 +4,13 @@ badge | GraphQL-Markdown - - + + -

badge

DEFAULT_CSS_CLASSNAME​

+

badge

DEFAULT_CSS_CLASSNAME​

const DEFAULT_CSS_CLASSNAME: "badge--secondary";
-

Source​

+

Defined in​

badge.ts:23

getTypeBadges()​

@@ -20,7 +20,7 @@

Parameters• groups?: Maybe<Partial<Record<SchemaEntity, Record<string, Maybe<string>>>>>

Returns​

Badge[]

-

Source​

+

Defined in​

badge.ts:25

printBadge()​

@@ -29,7 +29,7 @@

Parameters• __namedParameters: Badge

Returns​

MDXString

-

Source​

+

Defined in​

badge.ts:73

printBadges()​

@@ -39,7 +39,7 @@

Parameters• options: PrintTypeOptions

Returns​

string | MDXString

-

Source​

+

Defined in​

badge.ts:79

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/code/index.html b/api/printer-legacy/code/index.html index bdbb0e2a7..274b3f9e2 100644 --- a/api/printer-legacy/code/index.html +++ b/api/printer-legacy/code/index.html @@ -4,18 +4,18 @@ code | GraphQL-Markdown - - + + -

code

printCodeArguments()​

+

code

printCodeArguments()​

function printCodeArguments(type, indentationLevel): string

Parameters​

• type: unknown

-

• indentationLevel: number= 1

+

• indentationLevel: number = 1

Returns​

string

-

Source​

+

Defined in​

code.ts:16

printCodeField()​

@@ -23,10 +23,10 @@

printCodeFiel

Parameters​

• type: unknown

• options?: PrintTypeOptions

-

• indentationLevel?: number= 0

+

• indentationLevel?: number = 0

Returns​

string | MDXString

-

Source​

+

Defined in​

code.ts:50

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/common/index.html b/api/printer-legacy/common/index.html index e3598ece6..0e0bb9743 100644 --- a/api/printer-legacy/common/index.html +++ b/api/printer-legacy/common/index.html @@ -4,18 +4,18 @@ common | GraphQL-Markdown - - + + -

common

formatDescription()​

+

common

formatDescription()​

function formatDescription(type, replacement): string | MDXString

Parameters​

• type: unknown

-

• replacement: Maybe<string>= NO_DESCRIPTION_TEXT

+

• replacement: Maybe<string> = NO_DESCRIPTION_TEXT

Returns​

string | MDXString

-

Source​

+

Defined in​

common.ts:54

hasPrintableDirective()​

@@ -25,7 +25,7 @@

Parameters• options?: Pick<PrintTypeOptions, "deprecated" | "onlyDocDirectives" | "skipDocDirectives">

Returns​

boolean

-

Source​

+

Defined in​

common.ts:105

printCustomDirectives()​

@@ -35,7 +35,7 @@

Parameters• options?: PrintTypeOptions

Returns​

string

-

Source​

+

Defined in​

common.ts:21

printDeprecation()​

@@ -44,7 +44,7 @@

Parameters• type: unknown

Returns​

string

-

Source​

+

Defined in​

common.ts:81

printDescription()​

@@ -55,7 +55,7 @@

Parameters• noText?: string

Returns​

string | MDXString

-

Source​

+

Defined in​

common.ts:94

printWarning()​

@@ -65,7 +65,7 @@

Parameters• title?: string

Returns​

string

-

Source​

+

Defined in​

common.ts:69

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/const/mdx/index.html b/api/printer-legacy/const/mdx/index.html index 37068ea01..2dcc3cf1f 100644 --- a/api/printer-legacy/const/mdx/index.html +++ b/api/printer-legacy/const/mdx/index.html @@ -4,13 +4,13 @@ mdx | GraphQL-Markdown - - + + -

mdx

mdx​

+
Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/const/options/index.html b/api/printer-legacy/const/options/index.html index c2b22e03f..0a9b2d919 100644 --- a/api/printer-legacy/const/options/index.html +++ b/api/printer-legacy/const/options/index.html @@ -4,27 +4,27 @@ options | GraphQL-Markdown - - + + -

options

SectionLevels​

+

options

SectionLevels​

Enumeration Members​

LEVEL_3​

LEVEL_3: "###";
-
Source​
+
Defined in​

const/options.ts:15

LEVEL_4​

LEVEL_4: "####";
-
Source​
+
Defined in​

const/options.ts:16

LEVEL_5​

LEVEL_5: "#####";
-
Source​
+
Defined in​

const/options.ts:17

NONE​

NONE: "";
-
Source​
+
Defined in​

const/options.ts:14

DEFAULT_OPTIONS​

@@ -44,12 +44,12 @@

schema
schema: Maybe<GraphQLSchema>;

skipDocDirectives​

skipDocDirectives: GraphQLDirective[];
-

Source​

+

Defined in​

const/options.ts:32

const PRINT_TYPE_DEFAULT_OPTIONS: Required<PrinterConfigPrintTypeOptions>;
-

Source​

+

Defined in​

const/options.ts:20

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/const/strings/index.html b/api/printer-legacy/const/strings/index.html index 61031690e..c13739257 100644 --- a/api/printer-legacy/const/strings/index.html +++ b/api/printer-legacy/const/strings/index.html @@ -4,63 +4,63 @@ strings | GraphQL-Markdown - - + + -

strings

DEPRECATED​

+

strings

DEPRECATED​

const DEPRECATED: "deprecated";
-

Source​

+

Defined in​

const/strings.ts:27

FRONT_MATTER_DELIMITER​

const FRONT_MATTER_DELIMITER: "---";
-

Source​

+

Defined in​

const/strings.ts:19

HIDE_DEPRECATED​

const HIDE_DEPRECATED: "<><span className=\"deprecated\">Hide deprecated</span></>";
-

Source​

+

Defined in​

const/strings.ts:29

MARKDOWN_CODE_INDENTATION​

const MARKDOWN_CODE_INDENTATION: "  ";
-

Source​

+

Defined in​

const/strings.ts:20

MARKDOWN_EOC​

-
const MARKDOWN_EOC: "\n\n";
-

Source​

+
const MARKDOWN_EOC: "\n``\n";
+

Defined in​

const/strings.ts:23

MARKDOWN_EOL​

const MARKDOWN_EOL: "\n";
-

Source​

+

Defined in​

const/strings.ts:21

MARKDOWN_EOP​

const MARKDOWN_EOP: "\n\n";
-

Source​

+

Defined in​

const/strings.ts:22

MARKDOWN_SOC​

-
const MARKDOWN_SOC: "\ngraphql\n";
-

Source​

+
const MARKDOWN_SOC: "\n``graphql\n";
+

Defined in​

const/strings.ts:24

NO_DESCRIPTION_TEXT​

const NO_DESCRIPTION_TEXT: "No description";
-

Source​

+

Defined in​

const/strings.ts:17

ROOT_TYPE_LOCALE​

const ROOT_TYPE_LOCALE: RootTypeLocale;
-

Source​

+

Defined in​

const/strings.ts:3

SHOW_DEPRECATED​

const SHOW_DEPRECATED: "<><span className=\"deprecated\">Show deprecated</span></>";
-

Source​

+

Defined in​

const/strings.ts:31

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/directive/index.html b/api/printer-legacy/directive/index.html index 6c41603ec..0f35ca333 100644 --- a/api/printer-legacy/directive/index.html +++ b/api/printer-legacy/directive/index.html @@ -4,11 +4,11 @@ directive | GraphQL-Markdown - - + + -

directive

getCustomDirectiveResolver()​

+

directive

getCustomDirectiveResolver()​

function getCustomDirectiveResolver(
   resolver, 
   type, 
   constDirectiveOption, 
fallback?): Maybe<string>

Parameters​

• resolver: CustomDirectiveResolver

@@ -17,7 +17,7 @@

Parameters• fallback?: Maybe<string>

Returns​

Maybe<string>

-

Source​

+

Defined in​

directive.ts:17

getCustomTags()​

@@ -27,7 +27,7 @@

Parameters• options: PrintTypeOptions

Returns​

Badge[]

-

Source​

+

Defined in​

directive.ts:89

printCustomDirective()​

@@ -38,7 +38,7 @@

Parameters• options: PrintTypeOptions

Returns​

Maybe<string>

-

Source​

+

Defined in​

directive.ts:37

printCustomDirectives()​

@@ -48,7 +48,7 @@

Parameters• options: PrintTypeOptions

Returns​

string

-

Source​

+

Defined in​

directive.ts:59

printCustomTags()​

@@ -58,7 +58,7 @@

Parameters• options: PrintTypeOptions

Returns​

string | MDXString

-

Source​

+

Defined in​

directive.ts:115

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/example/index.html b/api/printer-legacy/example/index.html index 9ebe98845..f08983060 100644 --- a/api/printer-legacy/example/index.html +++ b/api/printer-legacy/example/index.html @@ -4,17 +4,17 @@ example | GraphQL-Markdown - - + + -

example

getDirectiveExampleOption()​

+
Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/frontmatter/index.html b/api/printer-legacy/frontmatter/index.html index fa8dcf362..c17b12deb 100644 --- a/api/printer-legacy/frontmatter/index.html +++ b/api/printer-legacy/frontmatter/index.html @@ -4,19 +4,19 @@ frontmatter | GraphQL-Markdown - - + + -

frontmatter

formatFrontMatterProp()​

+
Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/graphql/directive/index.html b/api/printer-legacy/graphql/directive/index.html index a3c326846..2757a3230 100644 --- a/api/printer-legacy/graphql/directive/index.html +++ b/api/printer-legacy/graphql/directive/index.html @@ -4,18 +4,18 @@ directive | GraphQL-Markdown - - + + -

directive

printCodeDirective()​

+
Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/graphql/enum/index.html b/api/printer-legacy/graphql/enum/index.html index af9012b42..9d0ca30ec 100644 --- a/api/printer-legacy/graphql/enum/index.html +++ b/api/printer-legacy/graphql/enum/index.html @@ -4,18 +4,18 @@ enum | GraphQL-Markdown - - + + -

enum

printCodeEnum()​

+
Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/graphql/input/index.html b/api/printer-legacy/graphql/input/index.html index 91f6a43df..c85f65a8d 100644 --- a/api/printer-legacy/graphql/input/index.html +++ b/api/printer-legacy/graphql/input/index.html @@ -4,18 +4,18 @@ input | GraphQL-Markdown - - + + -

input

printCodeInput()​

+
Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/graphql/interface/index.html b/api/printer-legacy/graphql/interface/index.html index 25cc7f193..f2b9b6247 100644 --- a/api/printer-legacy/graphql/interface/index.html +++ b/api/printer-legacy/graphql/interface/index.html @@ -4,18 +4,18 @@ interface | GraphQL-Markdown - - + + -

interface

printCodeInterface()​

+
Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/graphql/object/index.html b/api/printer-legacy/graphql/object/index.html index 97f13196a..2cd8d0db1 100644 --- a/api/printer-legacy/graphql/object/index.html +++ b/api/printer-legacy/graphql/object/index.html @@ -4,18 +4,18 @@ object | GraphQL-Markdown - - + + -

object

printCodeObject()​

+

object

printCodeObject()​

function printCodeObject(type, options): string

Parameters​

• type: unknown

• options: PrintTypeOptions

Returns​

string

-

Source​

+

Defined in​

graphql/object.ts:74

printCodeType()​

@@ -26,7 +26,7 @@

Parameters• options: PrintTypeOptions

Returns​

string

-

Source​

+

Defined in​

graphql/object.ts:40

printObjectMetadata()​

@@ -36,7 +36,7 @@

Parameters• options: PrintTypeOptions

Returns​

string

-

Source​

+

Defined in​

graphql/object.ts:25

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/graphql/operation/index.html b/api/printer-legacy/graphql/operation/index.html index 91116a289..48f8c05db 100644 --- a/api/printer-legacy/graphql/operation/index.html +++ b/api/printer-legacy/graphql/operation/index.html @@ -4,19 +4,19 @@ operation | GraphQL-Markdown - - + + -

operation

printCodeOperation()​

+

operation

printCodeOperation()​

function printCodeOperation(
   type, 
   options?, 
   indentationLevel?): string | MDXString

Parameters​

• type: unknown

• options?: PrintTypeOptions

-

• indentationLevel?: number= 0

+

• indentationLevel?: number = 0

Returns​

string | MDXString

-

Source​

+

Defined in​

graphql/operation.ts:37

printOperationMetadata()​

@@ -26,7 +26,7 @@

Parameters• options: PrintTypeOptions

Returns​

string | MDXString

-

Source​

+

Defined in​

graphql/operation.ts:23

printOperationType()​

@@ -36,7 +36,7 @@

Parameters• options: PrintTypeOptions

Returns​

string | MDXString

-

Source​

+

Defined in​

graphql/operation.ts:8

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/graphql/scalar/index.html b/api/printer-legacy/graphql/scalar/index.html index f834c4c24..c6d28442b 100644 --- a/api/printer-legacy/graphql/scalar/index.html +++ b/api/printer-legacy/graphql/scalar/index.html @@ -4,18 +4,18 @@ scalar | GraphQL-Markdown - - + + -

scalar

printCodeScalar()​

+

scalar

printCodeScalar()​

function printCodeScalar(type, options?): string

Parameters​

• type: unknown

• options?: PrintTypeOptions

Returns​

string

-

Source​

+

Defined in​

graphql/scalar.ts:31

printScalarMetadata()​

@@ -25,7 +25,7 @@

Parameters• options?: PrintTypeOptions

Returns​

string | MDXString

-

Source​

+

Defined in​

graphql/scalar.ts:24

printSpecification()​

@@ -34,7 +34,7 @@

Parameters• type: unknown

Returns​

string | MDXString

-

Source​

+

Defined in​

graphql/scalar.ts:8

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/graphql/union/index.html b/api/printer-legacy/graphql/union/index.html index df2d3a74f..dc41c855a 100644 --- a/api/printer-legacy/graphql/union/index.html +++ b/api/printer-legacy/graphql/union/index.html @@ -4,18 +4,18 @@ union | GraphQL-Markdown - - + + -

union

printCodeUnion()​

+
Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/group/index.html b/api/printer-legacy/group/index.html index 3def28b1e..10dea6167 100644 --- a/api/printer-legacy/group/index.html +++ b/api/printer-legacy/group/index.html @@ -4,11 +4,11 @@ group | GraphQL-Markdown - - + + -

group

getGroup()​

+
Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/link/index.html b/api/printer-legacy/link/index.html index 77f86383a..274e592e6 100644 --- a/api/printer-legacy/link/index.html +++ b/api/printer-legacy/link/index.html @@ -4,17 +4,17 @@ link | GraphQL-Markdown - - + + -

link

getCategoryLocale()​

+

link

getCategoryLocale()​

function getCategoryLocale(type): Maybe<TypeLocale>

Parameters​

• type: unknown

Returns​

Maybe<TypeLocale>

-

Source​

+

Defined in​

link.ts:37

getLinkApiGroupFolder()​

@@ -23,7 +23,7 @@

Parameters• type: unknown

Returns​

string

-

Source​

+

Defined in​

link.ts:97

getLinkCategoryFolder()​

@@ -33,7 +33,7 @@

Parameters• operationLocale?: Maybe<TypeLocale>

Returns​

Maybe<string>

-

Source​

+

Defined in​

link.ts:59

getLinkDeprecatedFolder()​

@@ -43,7 +43,7 @@

Parameters• option: Maybe<TypeDeprecatedOption>

Returns​

string

-

Source​

+

Defined in​

link.ts:101

@@ -54,7 +54,7 @@

Parameters• options: PrintLinkOptions

Returns​

Maybe<TypeLink>

-

Source​

+

Defined in​

link.ts:158

hasOptionParentType()​

@@ -63,7 +63,7 @@

Parameters• options: PrintLinkOptions

Returns​

boolean

-

Source​

+

Defined in​

link.ts:88

hasOptionWithAttributes()​

@@ -72,7 +72,7 @@

Parameters• options: PrintLinkOptions

Returns​

boolean

-

Source​

+

Defined in​

link.ts:84

@@ -82,17 +82,17 @@

Parameters• options: PrintLinkOptions

Returns​

string

-

Source​

+

Defined in​

link.ts:201

printLinkAttributes()​

function printLinkAttributes(type, text): string

Parameters​

• type: unknown

-

• text: Maybe<string>= ""

+

• text: Maybe<string> = ""

Returns​

string

-

Source​

+

Defined in​

link.ts:174

@@ -102,7 +102,7 @@

Parameters• options: PrintLinkOptions

Returns​

string | MDXString

-

Source​

+

Defined in​

link.ts:225

@@ -114,7 +114,7 @@

Parameters• options: PrintLinkOptions

Returns​

TypeLink

-

Source​

+

Defined in​

link.ts:108

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/printer/index.html b/api/printer-legacy/printer/index.html index 4044f28f3..c05edd93c 100644 --- a/api/printer-legacy/printer/index.html +++ b/api/printer-legacy/printer/index.html @@ -4,11 +4,11 @@ printer | GraphQL-Markdown - - + + -

printer

Printer​

+

printer

Printer​

Implements​

  • IPrinter
    • @@ -21,44 +21,44 @@
    ReturnsProperties​

    options​

    static options: Readonly<Maybe<PrintTypeOptions>>;
    -
    Source​
    +
    Defined in​

    printer.ts:66

    printCustomDirectives()​

    -
    static readonly printCustomDirectives: (type, options) => string;
    +
    readonly static printCustomDirectives: (type, options) => string;
    Parameters​

    • type: unknown

    • options: PrintTypeOptions

    Returns​

    string

    -
    Source​
    +
    Defined in​

    printer.ts:70

    printCustomTags()​

    -
    static readonly printCustomTags: (type, options) => string | MDXString;
    +
    readonly static printCustomTags: (type, options) => string | MDXString;
    Parameters​

    • type: unknown

    • options: PrintTypeOptions

    Returns​

    string | MDXString

    -
    Source​
    +
    Defined in​

    printer.ts:72

    printDescription()​

    -
    static readonly printDescription: (type, options?, noText?) => string | MDXString;
    +
    readonly static printDescription: (type, options?, noText?) => string | MDXString;
    Parameters​

    • type: unknown

    • options?: PrintTypeOptions

    • noText?: string

    Returns​

    string | MDXString

    -
    Source​
    +
    Defined in​

    printer.ts:68

    Methods​

    init()​

    static init(
       schema, 
       baseURL, 
       linkRoot, 
       __namedParameters): void
    Parameters​

    • schema: Maybe<GraphQLSchema>

    -

    • baseURL: Maybe<string>= "schema"

    -

    • linkRoot: Maybe<string>= "/"

    -

    • __namedParameters= undefined

    +

    • baseURL: Maybe<string> = "schema"

    +

    • linkRoot: Maybe<string> = "/"

    +

    • __namedParameters = ...

    • __namedParameters.customDirectives?: CustomDirectiveMap

    • __namedParameters.deprecated?: TypeDeprecatedOption

    • __namedParameters.groups?: Partial<Record<SchemaEntity, Record<string, Maybe<string>>>>

    @@ -68,72 +68,72 @@
    Parameters• __namedParameters.skipDocDirectives?: GraphQLDirective[]

    Returns​

    void

    -
    Source​
    +
    Defined in​

    printer.ts:74

    printCode()​

    -
    static readonly printCode(type, options): string
    +
    readonly static printCode(type, options): string
    Parameters​

    • type: unknown

    • options: PrintTypeOptions

    Returns​

    string

    -
    Source​
    +
    Defined in​

    printer.ts:141

    printExample()​

    -
    static readonly printExample(type, options): string
    +
    readonly static printExample(type, options): string
    Parameters​

    • type: unknown

    • options: PrintTypeOptions

    Returns​

    string

    -
    Source​
    +
    Defined in​

    printer.ts:186

    printHeader()​

    -
    static readonly printHeader(
       id, 
       title, 
       options): string
    +
    readonly static printHeader(
       id, 
       title, 
       options): string
    Parameters​

    • id: string

    • title: string

    • options: PrintTypeOptions

    Returns​

    string

    -
    Source​
    +
    Defined in​

    printer.ts:131

    printMetaTags()​

    -
    static readonly printMetaTags(_type, __namedParameters): string | MDXString
    +
    readonly static printMetaTags(_type, __namedParameters): string | MDXString
    Parameters​

    • _type: unknown

    • __namedParameters: PrintTypeOptions

    Returns​

    string | MDXString

    -
    Source​
    +
    Defined in​

    printer.ts:246

    printRelations()​

    -
    static readonly printRelations(type, options): string | MDXString
    +
    readonly static printRelations(type, options): string | MDXString
    Parameters​

    • type: unknown

    • options: PrintTypeOptions

    Returns​

    string | MDXString

    -
    Source​
    +
    Defined in​

    printer.ts:236

    printType()​

    -
    static readonly printType(
       name, 
       type, 
    options?): Maybe<MDXString>
    +
    readonly static printType(
       name, 
       type, 
    options?): Maybe<MDXString>
    Parameters​

    • name: Maybe<string>

    • type: unknown

    • options?: Maybe<Partial<PrintTypeOptions>>

    Returns​

    Maybe<MDXString>

    -
    Source​
    +
    Defined in​

    printer.ts:265

    printTypeMetadata()​

    -
    static readonly printTypeMetadata(type, options): string | MDXString
    +
    readonly static printTypeMetadata(type, options): string | MDXString
    Parameters​

    • type: unknown

    • options: PrintTypeOptions

    Returns​

    string | MDXString

    -
    Source​
    +
    Defined in​

    printer.ts:207

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/relation/index.html b/api/printer-legacy/relation/index.html index 8ffc62911..dca2db303 100644 --- a/api/printer-legacy/relation/index.html +++ b/api/printer-legacy/relation/index.html @@ -4,22 +4,22 @@ relation | GraphQL-Markdown - - + + -

relation

getRootTypeLocaleFromString()​

+

relation

getRootTypeLocaleFromString()​

function getRootTypeLocaleFromString(text): Maybe<TypeLocale>

Parameters​

• text: string

Returns​

Maybe<TypeLocale>

-

Source​

+

Defined in​

relation.ts:25

printRelationOf()​

function printRelationOf<T>(
   type, 
   section, 
   getRelation, 
   options): string | MDXString
-

Type parameters​

+

Type Parameters​

• T

Parameters​

• type: unknown

@@ -28,7 +28,7 @@

Parameters• options: PrintTypeOptions

Returns​

string | MDXString

-

Source​

+

Defined in​

relation.ts:36

printRelations()​

@@ -38,7 +38,7 @@

Parameters• options: PrintTypeOptions

Returns​

string | MDXString

-

Source​

+

Defined in​

relation.ts:91

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/printer-legacy/section/index.html b/api/printer-legacy/section/index.html index 618e0a89a..4020d8e13 100644 --- a/api/printer-legacy/section/index.html +++ b/api/printer-legacy/section/index.html @@ -4,18 +4,18 @@ section | GraphQL-Markdown - - + + -

section

sectionLevels​

+

section

sectionLevels​

const sectionLevels: SectionLevel[];
-

Source​

+

Defined in​

section.ts:24

printMetadataSection()​

function printMetadataSection<T, V>(
   type, 
   values, 
   section, 
   options): string | MDXString
-

Type parameters​

+

Type Parameters​

• T

• V

Parameters​

@@ -25,12 +25,12 @@

Parameters• options: PrintTypeOptions

Returns​

string | MDXString

-

Source​

+

Defined in​

section.ts:143

printSection()​

function printSection<V>(
   values, 
   section, 
   options): string | MDXString
-

Type parameters​

+

Type Parameters​

• V

Parameters​

• values: V[] | readonly V[]

@@ -38,31 +38,31 @@

Parameters• options: PrintTypeOptions

Returns​

string | MDXString

-

Source​

+

Defined in​

section.ts:98

printSectionItem()​

function printSectionItem<T>(type, options): string | MDXString
-

Type parameters​

+

Type Parameters​

• T

Parameters​

• type: T

• options: PrintTypeOptions

Returns​

string | MDXString

-

Source​

+

Defined in​

section.ts:30

printSectionItems()​

function printSectionItems<V>(values, options): string | MDXString
-

Type parameters​

+

Type Parameters​

• V

Parameters​

• values: V | V[]

• options: PrintTypeOptions

Returns​

string | MDXString

-

Source​

+

Defined in​

section.ts:71

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/types/globals/index.html b/api/types/globals/index.html index 96158c828..5fa2785b2 100644 --- a/api/types/globals/index.html +++ b/api/types/globals/index.html @@ -4,10 +4,10 @@ types | GraphQL-Markdown - - + + -
Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
+
Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/utils/array/index.html b/api/utils/array/index.html index b8c533699..c0e51fb7c 100644 --- a/api/utils/array/index.html +++ b/api/utils/array/index.html @@ -4,16 +4,14 @@ array | GraphQL-Markdown - - + + -

array

Internal library of helpers for manipulating array and list.

+

array

Internal library of helpers for manipulating array and list.

convertArrayToMapObject()​

-

Internal

function convertArrayToMapObject<T>(list): Maybe<Record<string, T>>
-

Returns a k/v object from an array of objects with a name property.

-

Type parameters​

+

Type Parameters​

• T

the type of objects the list contains.

Parameters​

@@ -22,24 +20,18 @@

ParametersReturns​

Maybe<Record<string, T>>

an array of object values with name as key, or undefined if list is not a valid array.

-

Example​

-
import { convertArrayToMapObject } from '@graphql-markdown/utils/array';

convertArrayToMapObject([
    { name: true },
    { name: "test" },
    { name: 123 },
    { name2: 1234 },
  ]);

// Expected result: {
//   true: { name: true },
//   test: { name: "test" },
//   "123": { name: 123 },
// }
-

Source​

+

Defined in​

array.ts:76

toArray()​

-

Internal

function toArray(recordMap): Maybe<unknown[]>
-

Returns an array of values from a k/v object.

Parameters​

• recordMap: Maybe<Record<string, unknown>>

the key/value record object to be converted.

Returns​

Maybe<unknown[]>

an array of object values, or undefined if recordMap is not a valid object.

-

Example​

-
import { toArray } from '@graphql-markdown/utils/array';

toArray({
    bool: true,
    string: "test",
    number: 123,
    array: ["one", "two"],
    child: { key: "value" },
  });

// Expected result: [true, "test", 123, ["one", "two"], { key: "value" }]
-

Source​

+

Defined in​

array.ts:34

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/utils/fs/index.html b/api/utils/fs/index.html index 004c71be9..357722613 100644 --- a/api/utils/fs/index.html +++ b/api/utils/fs/index.html @@ -4,11 +4,11 @@ fs | GraphQL-Markdown - - + + -

fs

Library of helper functions for handling files and folders.

+

fs

Library of helper functions for handling files and folders.

ensureDir()​

function ensureDir(location): Promise<void>

Asynchronously create a folder structure if it does not exist.

@@ -17,30 +17,22 @@

Parametersfolder structure in path format.

Returns​

Promise<void>

-

Example​

-
import { ensureDir } from '@graphql-markdown/utils/fs';

await ensureDir("./.temp/local")

// Creates both folders if they do not exists.
-

Source​

+

Defined in​

fs.ts:57

fileExists()​

function fileExists(location): Promise<boolean>
-

Asynchronously check if a file or folder exists at the path location.

Parameters​

• location: string

file or folder location.

Returns​

Promise<boolean>

true if the path is valid, else false if not.

-

Example​

-
import { fileExists } from '@graphql-markdown/utils/fs';

await fileExists("./.temp/local")

// Expected true if path is valid, false if not
-

Source​

+

Defined in​

fs.ts:32

saveFile()​

function saveFile(
   location, 
   content, 
prettify?): Promise<void>
-

Asynchronously save a file with a string content at specified location in local FS. -Override the file content if the file already exists. -The function calls ensureDir(dirname(location)) to create the folder structure if missing.

Parameters​

• location: string

file location.

@@ -51,9 +43,7 @@

ParametersReturns​

Promise<void>

true if the path is valid, else false if not.

-

Example​

-
import { saveFile } from '@graphql-markdown/utils/fs';

await saveFile("./.temp/local.md", "foobar")

// Created .temp folder if it does not exists, and save data into local.md
-

Source​

+

Defined in​

fs.ts:85

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/utils/object/index.html b/api/utils/object/index.html index 01a60bede..769dd8b53 100644 --- a/api/utils/object/index.html +++ b/api/utils/object/index.html @@ -4,24 +4,20 @@ object | GraphQL-Markdown - - + + -

object

Internal library of helpers for manipulating objects.

+

object

Internal library of helpers for manipulating objects.

isEmpty()​

-

Internal

function isEmpty(obj): boolean
-

Check if an object contains key/value records.

Parameters​

• obj: unknown

the key/value record object.

Returns​

boolean

false if the object is a valid k/v set of records, else true.

-

Example​

-
import { isEmpty } from '@graphql-markdown/utils/object';

const obj = {
  bool: true,
  string: "test",
  number: 123,
  array: ["one", "two"],
  child: { key: "value" },
};

isEmpty(obj); // Returns false

isEmpty({}); // Returns true
-

Source​

+

Defined in​

object.ts:34

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/utils/prettier/index.html b/api/utils/prettier/index.html index e89aafa1a..009c5abc3 100644 --- a/api/utils/prettier/index.html +++ b/api/utils/prettier/index.html @@ -4,15 +4,13 @@ prettier | GraphQL-Markdown - - + + -

prettier

Internal library for prettifying files using prettier.

+

prettier

Internal library for prettifying files using prettier.

prettify()​

-

Internal

function prettify(content, parser): Promise<undefined | string>
-

Prettify a string using prettier.format.

Parameters​

• content: string

the string to be prettified.

@@ -21,45 +19,29 @@

ParametersReturns​

Promise<undefined | string>

a prettified string, or undefined if an error occurred.

-

Remarks​

-

This function logs a warning message on error.

-

See​

-

https://prettier.io/docs/en/options#parser for the list of parsers.

-

Source​

+

Defined in​

prettier.ts:29

prettifyJavascript()​

-

Internal

function prettifyJavascript(content): Promise<undefined | string>
-

Prettify a Javascript string using prettify and babel parser.

Parameters​

• content: string

the string to be prettified.

Returns​

Promise<undefined | string>

a prettified string, or undefined if an error occurred.

-

Remarks​

-

Same as prettify(content, "babel").

-

See​

-

prettify

-

Source​

+

Defined in​

prettier.ts:82

prettifyMarkdown()​

-

Internal

function prettifyMarkdown(content): Promise<undefined | string>
-

Prettify a Markdown string using prettify and markdown parser.

Parameters​

• content: string

the string to be prettified.

Returns​

Promise<undefined | string>

a prettified string, or undefined if an error occurred.

-

Remarks​

-

Same as prettify(content, "markdown").

-

See​

-

prettify

-

Source​

+

Defined in​

prettier.ts:61

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/utils/string/index.html b/api/utils/string/index.html index c94d0a58b..8ec69c807 100644 --- a/api/utils/string/index.html +++ b/api/utils/string/index.html @@ -4,90 +4,70 @@ string | GraphQL-Markdown - - + + -

string

Library of helpers for formatting strings.

+

string

Library of helpers for formatting strings.

capitalize()​

function capitalize(str): string
-

Returns a string in lowercase excepted for the 1st character capitalized using firstUppercase.

Parameters​

• str: Maybe<string>

the string to be transformed.

Returns​

string

a capitalized string, or an empty string if str is not a valid string.

-

Example​

-
import { capitalize } from "@graphql-markdown/utils/string";

capitalize("the quick Brown Fox");
// Expected result: "The quick brown fox"
-

Source​

+

Defined in​

string.ts:224

escapeMDX()​

-

Internal

function escapeMDX(str): string
-

Returns a string with MDX special characters converted to HTML unicode using toHTMLUnicode. -Characters within code notation should not be converted. -List of special characters: {, <, >, }

Parameters​

• str: unknown

the string to be transformed.

Returns​

string

a string with MDX special characters replaced by HTML unicode equivalents.

-

Example​

-
import { escapeMDX } from "@graphql-markdown/utils/string";

escapeMDX("{MDX} <special> characters");
// Expected result: "&#x007B;MDX&#x007D; &#x003C;special&#x003E; characters"

escapeMDX("`{MDX}` `<special>` characters");
// Expected result: "`{MDX}` `<special>` characters"
-

Source​

+

Defined in​

string.ts:177

firstUppercase()​

function firstUppercase(str): string
-

Returns a string with the 1st character in uppercase.

Parameters​

• str: Maybe<string>

the string to be transformed.

Returns​

string

a string with the 1st character in uppercase, or an empty string if str is not a valid string.

-

Example​

-
import { firstUppercase } from "@graphql-markdown/utils/string";

firstUppercase("the quick Brown Fox");
// Expected result: "The quick Brown Fox"
-

Source​

+

Defined in​

string.ts:200

kebabCase()​

function kebabCase(str): string
-

Returns a lowercase string with - as replacement for non alphanum characters using stringCaseBuilder.

Parameters​

• str: Maybe<string>

the string to be transformed.

Returns​

string

a string converted to start case, or an empty string if str is not a valid string.

-

Example​

-
import { kebabCase } from "@graphql-markdown/utils/string";

kebabCase("The quick brown Fox");
// Expected result: "the-quick-brown-fox"
-

Source​

+

Defined in​

string.ts:267

prune()​

-

Internal

function prune(str, substr): string
-

Returns a string pruned on both start and end, similar to trim() but with any substring.

Parameters​

• str: Maybe<string>

the string to be pruned.

-

• substr: string= ""

+

• substr: string = ""

the substring to be removed from str.

Returns​

string

a pruned string, or an empty string if str is not a valid string.

-

Example​

-
import { prune } from "@graphql-markdown/utils/string";

const text = "**The quick brown fox jumps over the lazy dog.**";

prune(text, "**");
// Expected result: "The quick brown fox jumps over the lazy dog."
-

Source​

+

Defined in​

string.ts:58

replaceDiacritics()​

function replaceDiacritics(str): string
-

Replaces diacritics by non-diacritic equivalent characters.

Parameters​

• str: Maybe<string>

the string to be transformed.

@@ -97,45 +77,36 @@

ReturnsExample​

-
import { replaceDiacritics } from "@graphql-markdown/utils/string";

replaceDiacritics("Âéêś"); // Expected result: "Aees"
-

See​

-

StackOverflow source.

-

Source​

+

Defined in​

string.ts:27

slugify()​

function slugify(str): string
-

Alias of kebabCase.

+

Returns a lowercase string with - as replacement for non alphanum characters using stringCaseBuilder.

Parameters​

• str: Maybe<string>

+

the string to be transformed.

Returns​

string

-

Alias​

-

Source​

+

a string converted to start case, or an empty string if str is not a valid string.

+

Example​

+
import { kebabCase } from "@graphql-markdown/utils/string";

kebabCase("The quick brown Fox");
// Expected result: "the-quick-brown-fox"
+

Defined in​

string.ts:282

startCase()​

function startCase(str): string
-

Applies firstUppercase using stringCaseBuilder to every word of a string with space character as separator.

Parameters​

• str: Maybe<string>

the string to be transformed.

Returns​

string

a string converted to start case, or an empty string if str is not a valid string.

-

Example​

-
import { startCase } from "@graphql-markdown/utils/string";

startCase("the quick Brown Fox");
// Expected result: "The Quick Brown Fox"
-

Source​

+

Defined in​

string.ts:246

stringCaseBuilder()​

-

Internal

function stringCaseBuilder(
   str, 
   transformation?, 
   separator?, 
   splitter?): string
-

Returns a string after applying a transformation function. -By default splitter expression will split the string into words, where non-alphanum chars are considered as word separators. -separator will be used for joining the words back together. -prune using separator is applied to the result of the transformation.

Parameters​

• str: Maybe<string>

the string to be transformed.

@@ -143,29 +114,23 @@

Parametersoptional transformation callback function.

• separator?: string

optional character separator for word-based transformation.

-

• splitter?: string | RegExp= undefined

+

• splitter?: string | RegExp = ...

optional regex or string rule for splitting string into word.

Returns​

string

a transformed string, or an empty string if str is not a valid string.

-

Example​

-
import { stringCaseBuilder } from "@graphql-markdown/utils/string";

const text = "The quick brown fox jumps over the lazy dog.";
const transformation = (word: string): string => `*${word}*`

stringCaseBuilder(text, transformation, " ");
// Expected result: "*The* *quick* *brown* *fox* *jumps* *over* *the* *lazy* *dog*"
-

Source​

+

Defined in​

string.ts:100

toHTMLUnicode()​

-

Internal

function toHTMLUnicode(char): string
-

Converts a character to its equivalent HTML unicode representation &#x0000.

Parameters​

• char: Maybe<string>

the character to be transformed.

Returns​

string

a HTML unicode representation of char, or an empty string if char is not a valid string.

-

Example​

-
import { toHTMLUnicode } from "@graphql-markdown/utils/string";

toHTMLUnicode("%"); // Expected result: "&#x0025;"
-

Source​

+

Defined in​

string.ts:146

Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/api/utils/url/index.html b/api/utils/url/index.html index 5bd25e57f..f1ba39420 100644 --- a/api/utils/url/index.html +++ b/api/utils/url/index.html @@ -4,10 +4,10 @@ url | GraphQL-Markdown - - + + -
Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
+
Copyright © 2020-2024 Grégory Heitz. Built with Docusaurus.
\ No newline at end of file diff --git a/assets/js/0999c2f7.db8278b6.js b/assets/js/0999c2f7.db8278b6.js new file mode 100644 index 000000000..9532e97b3 --- /dev/null +++ b/assets/js/0999c2f7.db8278b6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[2602],{7650:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>d,default:()=>p,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var i=n(74848),t=n(28453);const s={title:"prettier",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},d=void 0,l={id:"utils/prettier",title:"prettier",description:"Internal library for prettifying files using prettier.",source:"@site/api/utils/prettier.md",sourceDirName:"utils",slug:"/utils/prettier",permalink:"/api/utils/prettier",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"prettier",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},a={},c=[{value:"prettify()",id:"prettify",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"prettifyJavascript()",id:"prettifyjavascript",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3},{value:"prettifyMarkdown()",id:"prettifymarkdown",level:2},{value:"Parameters",id:"parameters-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Defined in",id:"defined-in-2",level:3}];function o(e){const r={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(r.p,{children:["Internal library for prettifying files using ",(0,i.jsx)(r.code,{children:"prettier"}),"."]}),"\n",(0,i.jsx)(r.h2,{id:"prettify",children:"prettify()"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"function prettify(content, parser): Promise\n"})}),"\n",(0,i.jsx)(r.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"content"}),": ",(0,i.jsx)(r.code,{children:"string"})]}),"\n",(0,i.jsx)(r.p,{children:"the string to be prettified."}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"parser"}),": ",(0,i.jsx)(r.code,{children:"string"})]}),"\n",(0,i.jsxs)(r.p,{children:["the ",(0,i.jsx)(r.code,{children:"prettier"})," parser to use."]}),"\n",(0,i.jsx)(r.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.code,{children:"Promise"}),"<",(0,i.jsx)(r.code,{children:"undefined"})," | ",(0,i.jsx)(r.code,{children:"string"}),">"]}),"\n",(0,i.jsx)(r.p,{children:"a prettified string, or undefined if an error occurred."}),"\n",(0,i.jsx)(r.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/utils/src/prettier.ts#L29",children:"prettier.ts:29"})}),"\n",(0,i.jsx)(r.hr,{}),"\n",(0,i.jsx)(r.h2,{id:"prettifyjavascript",children:"prettifyJavascript()"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"function prettifyJavascript(content): Promise\n"})}),"\n",(0,i.jsx)(r.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"content"}),": ",(0,i.jsx)(r.code,{children:"string"})]}),"\n",(0,i.jsx)(r.p,{children:"the string to be prettified."}),"\n",(0,i.jsx)(r.h3,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.code,{children:"Promise"}),"<",(0,i.jsx)(r.code,{children:"undefined"})," | ",(0,i.jsx)(r.code,{children:"string"}),">"]}),"\n",(0,i.jsx)(r.p,{children:"a prettified string, or undefined if an error occurred."}),"\n",(0,i.jsx)(r.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/utils/src/prettier.ts#L82",children:"prettier.ts:82"})}),"\n",(0,i.jsx)(r.hr,{}),"\n",(0,i.jsx)(r.h2,{id:"prettifymarkdown",children:"prettifyMarkdown()"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"function prettifyMarkdown(content): Promise\n"})}),"\n",(0,i.jsx)(r.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"content"}),": ",(0,i.jsx)(r.code,{children:"string"})]}),"\n",(0,i.jsx)(r.p,{children:"the string to be prettified."}),"\n",(0,i.jsx)(r.h3,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.code,{children:"Promise"}),"<",(0,i.jsx)(r.code,{children:"undefined"})," | ",(0,i.jsx)(r.code,{children:"string"}),">"]}),"\n",(0,i.jsx)(r.p,{children:"a prettified string, or undefined if an error occurred."}),"\n",(0,i.jsx)(r.h3,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/utils/src/prettier.ts#L61",children:"prettier.ts:61"})})]})}function p(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},28453:(e,r,n)=>{n.d(r,{R:()=>d,x:()=>l});var i=n(96540);const t={},s=i.createContext(t);function d(e){const r=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function l(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:d(e.components),i.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0aee5409.b2fcf902.js b/assets/js/0aee5409.b2fcf902.js new file mode 100644 index 000000000..f0d1256bf --- /dev/null +++ b/assets/js/0aee5409.b2fcf902.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[8146],{38252:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>t,contentTitle:()=>d,default:()=>c,frontMatter:()=>a,metadata:()=>l,toc:()=>p});var s=r(74848),i=r(28453);const a={title:"guard",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},d=void 0,l={id:"graphql/guard",title:"guard",description:"Custom GraphQL type guards and property guards.",source:"@site/api/graphql/guard.md",sourceDirName:"graphql",slug:"/graphql/guard",permalink:"/api/graphql/guard",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"guard",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},t={},p=[{value:"instanceOf()",id:"instanceof",level:2},{value:"Type Parameters",id:"type-parameters",level:3},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"isApiType()",id:"isapitype",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3},{value:"isDeprecated()",id:"isdeprecated",level:2},{value:"Type Parameters",id:"type-parameters-1",level:3},{value:"Parameters",id:"parameters-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Defined in",id:"defined-in-2",level:3},{value:"isGraphQLFieldType()",id:"isgraphqlfieldtype",level:2},{value:"Parameters",id:"parameters-3",level:3},{value:"Returns",id:"returns-3",level:3},{value:"Defined in",id:"defined-in-3",level:3},{value:"isOperation()",id:"isoperation",level:2},{value:"Parameters",id:"parameters-4",level:3},{value:"Returns",id:"returns-4",level:3},{value:"Defined in",id:"defined-in-4",level:3},{value:"isSystemType()",id:"issystemtype",level:2},{value:"Parameters",id:"parameters-5",level:3},{value:"Returns",id:"returns-5",level:3},{value:"Defined in",id:"defined-in-5",level:3}];function h(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.p,{children:"Custom GraphQL type guards and property guards."}),"\n",(0,s.jsx)(n.h2,{id:"instanceof",children:"instanceOf()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function instanceOf(obj, type): obj is T\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Checks if a GraphQL named type is of generic type ",(0,s.jsx)(n.code,{children:"T"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsxs)(n.p,{children:["a GraphQL type to check against, eg ",(0,s.jsx)(n.code,{children:"GraphQLObjectType"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"obj"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n",(0,s.jsx)(n.p,{children:"a GraphQL named type from the GraphQL schema."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"type"})]}),"\n",(0,s.jsxs)(n.p,{children:["the GraphQL type ",(0,s.jsx)(n.code,{children:"T"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"obj is T"})}),"\n",(0,s.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/guard.ts#L57",children:"packages/graphql/src/guard.ts:57"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"isapitype",children:"isApiType()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function isApiType(type): boolean\n"})}),"\n",(0,s.jsx)(n.p,{children:"Checks if a type belongs to API (operation related)."}),"\n",(0,s.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"type"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n",(0,s.jsx)(n.p,{children:"a GraphQL type."}),"\n",(0,s.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/guard.ts#L100",children:"packages/graphql/src/guard.ts:100"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"isdeprecated",children:"isDeprecated()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function isDeprecated(obj): obj is DeprecatedType\n"})}),"\n",(0,s.jsx)(n.p,{children:"Checks if a GraphQL named type is deprecated."}),"\n",(0,s.jsx)(n.h3,{id:"type-parameters-1",children:"Type Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"T"})]}),"\n",(0,s.jsxs)(n.p,{children:["a GraphQL type to check against, eg ",(0,s.jsx)(n.code,{children:"GraphQLObjectType"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"obj"}),": ",(0,s.jsx)(n.code,{children:"T"})]}),"\n",(0,s.jsxs)(n.p,{children:["an instance of ",(0,s.jsx)(n.code,{children:"T"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"obj is DeprecatedType"})}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/guard.ts#L75",children:"packages/graphql/src/guard.ts:75"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"isgraphqlfieldtype",children:"isGraphQLFieldType()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function isGraphQLFieldType(type): type is GraphQLField\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Checks if a GraphQL named type is of type ",(0,s.jsx)(n.code,{children:"GraphQLField"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"parameters-3",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"type"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n",(0,s.jsx)(n.p,{children:"a GraphQL type."}),"\n",(0,s.jsx)(n.h3,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"type is GraphQLField"})}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/guard.ts#L38",children:"packages/graphql/src/guard.ts:38"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"isoperation",children:"isOperation()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function isOperation(type): type is GraphQLOperationType\n"})}),"\n",(0,s.jsx)(n.p,{children:"Checks if a GraphQL type a GraphQL operation (query, mutation, subscription)."}),"\n",(0,s.jsx)(n.h3,{id:"parameters-4",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"type"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n",(0,s.jsx)(n.p,{children:"a GraphQL type."}),"\n",(0,s.jsx)(n.h3,{id:"returns-4",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"type is GraphQLOperationType"})}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/guard.ts#L90",children:"packages/graphql/src/guard.ts:90"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"issystemtype",children:"isSystemType()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function isSystemType(type): boolean\n"})}),"\n",(0,s.jsx)(n.p,{children:"Checks if a type belongs to schema (schema type definition excluding operations related types)."}),"\n",(0,s.jsx)(n.h3,{id:"parameters-5",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"type"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n",(0,s.jsx)(n.p,{children:"a GraphQL type."}),"\n",(0,s.jsx)(n.h3,{id:"returns-5",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"boolean"})}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/guard.ts#L113",children:"packages/graphql/src/guard.ts:113"})})]})}function c(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>d,x:()=>l});var s=r(96540);const i={},a=s.createContext(i);function d(e){const n=s.useContext(a);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/0cba5814.d012126a.js b/assets/js/0cba5814.d012126a.js new file mode 100644 index 000000000..917723980 --- /dev/null +++ b/assets/js/0cba5814.d012126a.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[4947],{45341:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>t,contentTitle:()=>c,default:()=>h,frontMatter:()=>d,metadata:()=>l,toc:()=>o});var r=i(74848),s=i(28453);const d={title:"config",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},c=void 0,l={id:"core/config",title:"config",description:"DeprecatedOption",source:"@site/api/core/config.md",sourceDirName:"core",slug:"/core/config",permalink:"/api/core/config",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"config",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},t={},o=[{value:"DeprecatedOption",id:"deprecatedoption",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"DEFAULT",id:"default",level:4},{value:"Defined in",id:"defined-in",level:5},{value:"GROUP",id:"group",level:4},{value:"Defined in",id:"defined-in-1",level:5},{value:"SKIP",id:"skip",level:4},{value:"Defined in",id:"defined-in-2",level:5},{value:"DiffMethod",id:"diffmethod",level:2},{value:"Enumeration Members",id:"enumeration-members-1",level:3},{value:"FORCE",id:"force",level:4},{value:"Defined in",id:"defined-in-3",level:5},{value:"NONE",id:"none",level:4},{value:"Defined in",id:"defined-in-4",level:5},{value:"ASSET_HOMEPAGE_LOCATION",id:"asset_homepage_location",level:2},{value:"Defined in",id:"defined-in-5",level:3},{value:"DEFAULT_OPTIONS",id:"default_options",level:2},{value:"Defined in",id:"defined-in-6",level:3},{value:"DOCS_URL",id:"docs_url",level:2},{value:"Defined in",id:"defined-in-7",level:3},{value:"PACKAGE_NAME",id:"package_name",level:2},{value:"Defined in",id:"defined-in-8",level:3},{value:"buildConfig()",id:"buildconfig",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in-9",level:3},{value:"getCustomDirectives()",id:"getcustomdirectives",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-10",level:3},{value:"getDiffMethod()",id:"getdiffmethod",level:2},{value:"Parameters",id:"parameters-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Defined in",id:"defined-in-11",level:3},{value:"getDocDirective()",id:"getdocdirective",level:2},{value:"Parameters",id:"parameters-3",level:3},{value:"Returns",id:"returns-3",level:3},{value:"Defined in",id:"defined-in-12",level:3},{value:"getDocOptions()",id:"getdocoptions",level:2},{value:"Parameters",id:"parameters-4",level:3},{value:"Returns",id:"returns-4",level:3},{value:"Defined in",id:"defined-in-13",level:3},{value:"getOnlyDocDirectives()",id:"getonlydocdirectives",level:2},{value:"Parameters",id:"parameters-5",level:3},{value:"Returns",id:"returns-5",level:3},{value:"Defined in",id:"defined-in-14",level:3},{value:"getPrintTypeOptions()",id:"getprinttypeoptions",level:2},{value:"Parameters",id:"parameters-6",level:3},{value:"Returns",id:"returns-6",level:3},{value:"Defined in",id:"defined-in-15",level:3},{value:"getSkipDocDirectives()",id:"getskipdocdirectives",level:2},{value:"Parameters",id:"parameters-7",level:3},{value:"Returns",id:"returns-7",level:3},{value:"Defined in",id:"defined-in-16",level:3},{value:"getVisibilityDirectives()",id:"getvisibilitydirectives",level:2},{value:"Parameters",id:"parameters-8",level:3},{value:"Returns",id:"returns-8",level:3},{value:"onlyDocDirective",id:"onlydocdirective",level:4},{value:"skipDocDirective",id:"skipdocdirective",level:4},{value:"Defined in",id:"defined-in-17",level:3},{value:"parseDeprecatedDocOptions()",id:"parsedeprecateddocoptions",level:2},{value:"Parameters",id:"parameters-9",level:3},{value:"Returns",id:"returns-9",level:3},{value:"hide_table_of_contents",id:"hide_table_of_contents",level:4},{value:"pagination_next",id:"pagination_next",level:4},{value:"pagination_prev",id:"pagination_prev",level:4},{value:"Defined in",id:"defined-in-18",level:3},{value:"parseGroupByOption()",id:"parsegroupbyoption",level:2},{value:"Parameters",id:"parameters-10",level:3},{value:"Returns",id:"returns-10",level:3},{value:"Defined in",id:"defined-in-19",level:3}];function a(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"deprecatedoption",children:"DeprecatedOption"}),"\n",(0,r.jsx)(n.h3,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h4,{id:"default",children:"DEFAULT"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:'DEFAULT: "default";\n'})}),"\n",(0,r.jsx)(n.h5,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/config.ts#L33",children:"config.ts:33"})}),"\n",(0,r.jsx)(n.h4,{id:"group",children:"GROUP"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:'GROUP: "group";\n'})}),"\n",(0,r.jsx)(n.h5,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/config.ts#L34",children:"config.ts:34"})}),"\n",(0,r.jsx)(n.h4,{id:"skip",children:"SKIP"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:'SKIP: "skip";\n'})}),"\n",(0,r.jsx)(n.h5,{id:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/config.ts#L35",children:"config.ts:35"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"diffmethod",children:"DiffMethod"}),"\n",(0,r.jsx)(n.h3,{id:"enumeration-members-1",children:"Enumeration Members"}),"\n",(0,r.jsx)(n.h4,{id:"force",children:"FORCE"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:'FORCE: "FORCE";\n'})}),"\n",(0,r.jsx)(n.h5,{id:"defined-in-3",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/config.ts#L29",children:"config.ts:29"})}),"\n",(0,r.jsx)(n.h4,{id:"none",children:"NONE"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:'NONE: "NONE";\n'})}),"\n",(0,r.jsx)(n.h5,{id:"defined-in-4",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/config.ts#L28",children:"config.ts:28"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"asset_homepage_location",children:"ASSET_HOMEPAGE_LOCATION"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"const ASSET_HOMEPAGE_LOCATION: string;\n"})}),"\n",(0,r.jsx)(n.h3,{id:"defined-in-5",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/config.ts#L40",children:"config.ts:40"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"default_options",children:"DEFAULT_OPTIONS"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:'const DEFAULT_OPTIONS: Readonly & Required>>;\n'})}),"\n",(0,r.jsx)(n.h3,{id:"defined-in-6",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/config.ts#L47",children:"config.ts:47"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"docs_url",children:"DOCS_URL"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:'const DOCS_URL: "https://graphql-markdown.dev/docs";\n'})}),"\n",(0,r.jsx)(n.h3,{id:"defined-in-7",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/config.ts#L38",children:"config.ts:38"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"package_name",children:"PACKAGE_NAME"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:'const PACKAGE_NAME: "@graphql-markdown/docusaurus";\n'})}),"\n",(0,r.jsx)(n.h3,{id:"defined-in-8",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/config.ts#L39",children:"config.ts:39"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"buildconfig",children:"buildConfig()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function buildConfig(\n configFileOpts, \n cliOpts, \nid): Promise\n"})}),"\n",(0,r.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"configFileOpts"}),": ",(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"ConfigOptions"}),">"]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"cliOpts"}),": ",(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"CliOptions"}),">"]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"id"}),": ",(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"string"}),"> = ",(0,r.jsx)(n.code,{children:'"default"'})]}),"\n",(0,r.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Promise"}),"<",(0,r.jsx)(n.code,{children:"Options"}),">"]}),"\n",(0,r.jsx)(n.h3,{id:"defined-in-9",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/config.ts#L330",children:"config.ts:330"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"getcustomdirectives",children:"getCustomDirectives()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function getCustomDirectives(customDirectiveOptions, skipDocDirective?): Maybe\n"})}),"\n",(0,r.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"customDirectiveOptions"}),": ",(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"CustomDirective"}),">"]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"skipDocDirective?"}),": ",(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"DirectiveName"}),"[]>"]}),"\n",(0,r.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"CustomDirective"}),">"]}),"\n",(0,r.jsx)(n.h3,{id:"defined-in-10",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/config.ts#L170",children:"config.ts:170"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"getdiffmethod",children:"getDiffMethod()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function getDiffMethod(diff, force): TypeDiffMethod\n"})}),"\n",(0,r.jsx)(n.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"diff"}),": ",(0,r.jsx)(n.code,{children:"TypeDiffMethod"})]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"force"}),": ",(0,r.jsx)(n.code,{children:"boolean"})," = ",(0,r.jsx)(n.code,{children:"false"})]}),"\n",(0,r.jsx)(n.h3,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"TypeDiffMethod"})}),"\n",(0,r.jsx)(n.h3,{id:"defined-in-11",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/config.ts#L203",children:"config.ts:203"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"getdocdirective",children:"getDocDirective()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function getDocDirective(name): DirectiveName\n"})}),"\n",(0,r.jsx)(n.h3,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"name"}),": ",(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"DirectiveName"}),">"]}),"\n",(0,r.jsx)(n.h3,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"DirectiveName"})}),"\n",(0,r.jsx)(n.h3,{id:"defined-in-12",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/config.ts#L86",children:"config.ts:86"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"getdocoptions",children:"getDocOptions()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function getDocOptions(cliOpts?, configOptions?): Required\n"})}),"\n",(0,r.jsx)(n.h3,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"cliOpts?"}),": ",(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"CliOptions"})," & ",(0,r.jsx)(n.code,{children:"DeprecatedCliOptions"}),">"]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"configOptions?"}),": ",(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"ConfigDocOptions"})," & ",(0,r.jsx)(n.code,{children:"DeprecatedConfigDocOptions"}),">"]}),"\n",(0,r.jsx)(n.h3,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Required"}),"<",(0,r.jsx)(n.code,{children:"ConfigDocOptions"}),">"]}),"\n",(0,r.jsx)(n.h3,{id:"defined-in-13",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/config.ts#L253",children:"config.ts:253"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"getonlydocdirectives",children:"getOnlyDocDirectives()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function getOnlyDocDirectives(cliOpts, configFileOpts): DirectiveName[]\n"})}),"\n",(0,r.jsx)(n.h3,{id:"parameters-5",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"cliOpts"}),": ",(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"CliOptions"}),">"]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"configFileOpts"}),": ",(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"Pick"}),"<",(0,r.jsx)(n.code,{children:"ConfigOptions"}),", ",(0,r.jsx)(n.code,{children:'"onlyDocDirective"'}),">>"]}),"\n",(0,r.jsx)(n.h3,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"DirectiveName"}),"[]"]}),"\n",(0,r.jsx)(n.h3,{id:"defined-in-14",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/config.ts#L102",children:"config.ts:102"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"getprinttypeoptions",children:"getPrintTypeOptions()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function getPrintTypeOptions(cliOpts, configOptions): Required\n"})}),"\n",(0,r.jsx)(n.h3,{id:"parameters-6",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"cliOpts"}),": ",(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"CliOptions"}),">"]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"configOptions"}),": ",(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"ConfigPrintTypeOptions"}),">"]}),"\n",(0,r.jsx)(n.h3,{id:"returns-6",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Required"}),"<",(0,r.jsx)(n.code,{children:"ConfigPrintTypeOptions"}),">"]}),"\n",(0,r.jsx)(n.h3,{id:"defined-in-15",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/config.ts#L270",children:"config.ts:270"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"getskipdocdirectives",children:"getSkipDocDirectives()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function getSkipDocDirectives(cliOpts, configFileOpts): DirectiveName[]\n"})}),"\n",(0,r.jsx)(n.h3,{id:"parameters-7",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"cliOpts"}),": ",(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"CliOptions"}),">"]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"configFileOpts"}),": ",(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"Pick"}),"<",(0,r.jsx)(n.code,{children:"ConfigOptions"}),", ",(0,r.jsx)(n.code,{children:'"printTypeOptions"'})," | ",(0,r.jsx)(n.code,{children:'"skipDocDirective"'}),">>"]}),"\n",(0,r.jsx)(n.h3,{id:"returns-7",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"DirectiveName"}),"[]"]}),"\n",(0,r.jsx)(n.h3,{id:"defined-in-16",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/config.ts#L118",children:"config.ts:118"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"getvisibilitydirectives",children:"getVisibilityDirectives()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function getVisibilityDirectives(cliOpts, configFileOpts): object\n"})}),"\n",(0,r.jsx)(n.h3,{id:"parameters-8",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"cliOpts"}),": ",(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"CliOptions"}),">"]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"configFileOpts"}),": ",(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"Pick"}),"<",(0,r.jsx)(n.code,{children:"ConfigOptions"}),", ",(0,r.jsx)(n.code,{children:'"printTypeOptions"'})," | ",(0,r.jsx)(n.code,{children:'"skipDocDirective"'})," | ",(0,r.jsx)(n.code,{children:'"onlyDocDirective"'}),">>"]}),"\n",(0,r.jsx)(n.h3,{id:"returns-8",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"object"})}),"\n",(0,r.jsx)(n.h4,{id:"onlydocdirective",children:"onlyDocDirective"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"onlyDocDirective: DirectiveName[];\n"})}),"\n",(0,r.jsx)(n.h4,{id:"skipdocdirective",children:"skipDocDirective"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"skipDocDirective: DirectiveName[];\n"})}),"\n",(0,r.jsx)(n.h3,{id:"defined-in-17",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/config.ts#L145",children:"config.ts:145"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"parsedeprecateddocoptions",children:"parseDeprecatedDocOptions()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function parseDeprecatedDocOptions(cliOpts, configOptions): Partial\n"})}),"\n",(0,r.jsx)(n.h3,{id:"parameters-9",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"cliOpts"}),": ",(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"DeprecatedCliOptions"}),">"]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"configOptions"}),": ",(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"DeprecatedConfigDocOptions"}),">"]}),"\n",(0,r.jsx)(n.h3,{id:"returns-9",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Partial"}),"<",(0,r.jsx)(n.code,{children:"object"}),">"]}),"\n",(0,r.jsx)(n.h4,{id:"hide_table_of_contents",children:"hide_table_of_contents"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"hide_table_of_contents: boolean;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"pagination_next",children:"pagination_next"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"pagination_next: null;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"pagination_prev",children:"pagination_prev"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"pagination_prev: null;\n"})}),"\n",(0,r.jsx)(n.h3,{id:"defined-in-18",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/config.ts#L212",children:"config.ts:212"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"parsegroupbyoption",children:"parseGroupByOption()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function parseGroupByOption(groupOptions): Maybe\n"})}),"\n",(0,r.jsx)(n.h3,{id:"parameters-10",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"groupOptions"}),": ",(0,r.jsx)(n.code,{children:"unknown"})]}),"\n",(0,r.jsx)(n.h3,{id:"returns-10",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"GroupByDirectiveOptions"}),">"]}),"\n",(0,r.jsx)(n.h3,{id:"defined-in-19",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/config.ts#L301",children:"config.ts:301"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},28453:(e,n,i)=>{i.d(n,{R:()=>c,x:()=>l});var r=i(96540);const s={},d=r.createContext(s);function c(e){const n=r.useContext(d);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),r.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/24561158.602deab3.js b/assets/js/24561158.602deab3.js new file mode 100644 index 000000000..810c18358 --- /dev/null +++ b/assets/js/24561158.602deab3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[9589],{39933:e=>{e.exports=JSON.parse('{"pluginId":"example-group-by","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"schemaSidebar":[{"type":"category","label":"Common","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"Directives","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"auth","href":"/examples/group-by/common/directives/auth","docId":"common/directives/auth","unlisted":false},{"type":"link","label":"beta","href":"/examples/group-by/common/directives/beta","docId":"common/directives/beta","unlisted":false},{"type":"link","label":"complexity","href":"/examples/group-by/common/directives/complexity","docId":"common/directives/complexity","unlisted":false},{"type":"link","label":"deprecated","href":"/examples/group-by/common/directives/deprecated","docId":"common/directives/deprecated","unlisted":false},{"type":"link","label":"doc","href":"/examples/group-by/common/directives/doc","docId":"common/directives/doc","unlisted":false},{"type":"link","label":"example","href":"/examples/group-by/common/directives/example","docId":"common/directives/example","unlisted":false},{"type":"link","label":"include","href":"/examples/group-by/common/directives/include","docId":"common/directives/include","unlisted":false},{"type":"link","label":"noDoc","href":"/examples/group-by/common/directives/no-doc","docId":"common/directives/no-doc","unlisted":false},{"type":"link","label":"oneOf","href":"/examples/group-by/common/directives/one-of","docId":"common/directives/one-of","unlisted":false},{"type":"link","label":"skip","href":"/examples/group-by/common/directives/skip","docId":"common/directives/skip","unlisted":false},{"type":"link","label":"specifiedBy","href":"/examples/group-by/common/directives/specified-by","docId":"common/directives/specified-by","unlisted":false}],"href":"/examples/group-by/category/directives"},{"type":"category","label":"Enums","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Roles","href":"/examples/group-by/common/enums/roles","docId":"common/enums/roles","unlisted":false}],"href":"/examples/group-by/category/enums"},{"type":"category","label":"Interfaces","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Record","href":"/examples/group-by/common/interfaces/record","docId":"common/interfaces/record","unlisted":false}],"href":"/examples/group-by/category/interfaces"},{"type":"category","label":"Objects","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Course","href":"/examples/group-by/common/objects/course","docId":"common/objects/course","unlisted":false},{"type":"link","label":"DepartmentInformation","href":"/examples/group-by/common/objects/department-information","docId":"common/objects/department-information","unlisted":false},{"type":"link","label":"Semester","href":"/examples/group-by/common/objects/semester","docId":"common/objects/semester","unlisted":false}],"href":"/examples/group-by/category/objects"},{"type":"category","label":"Queries","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"searchRole","href":"/examples/group-by/common/queries/search-role","docId":"common/queries/search-role","unlisted":false}],"href":"/examples/group-by/category/queries"},{"type":"category","label":"Scalars","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"Boolean","href":"/examples/group-by/common/scalars/boolean","docId":"common/scalars/boolean","unlisted":false},{"type":"link","label":"Date","href":"/examples/group-by/common/scalars/date","docId":"common/scalars/date","unlisted":false},{"type":"link","label":"EmailAddress","href":"/examples/group-by/common/scalars/email-address","docId":"common/scalars/email-address","unlisted":false},{"type":"link","label":"ID","href":"/examples/group-by/common/scalars/id","docId":"common/scalars/id","unlisted":false},{"type":"link","label":"Int","href":"/examples/group-by/common/scalars/int","docId":"common/scalars/int","unlisted":false},{"type":"link","label":"PhoneNumber","href":"/examples/group-by/common/scalars/phone-number","docId":"common/scalars/phone-number","unlisted":false},{"type":"link","label":"String","href":"/examples/group-by/common/scalars/string","docId":"common/scalars/string","unlisted":false},{"type":"link","label":"Time","href":"/examples/group-by/common/scalars/time","docId":"common/scalars/time","unlisted":false},{"type":"link","label":"URL","href":"/examples/group-by/common/scalars/url","docId":"common/scalars/url","unlisted":false}],"href":"/examples/group-by/category/scalars"}],"href":"/examples/group-by/category/common"},{"type":"category","label":"Course","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"Mutations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"AddCourse","href":"/examples/group-by/course/mutations/add-course","docId":"course/mutations/add-course","unlisted":false},{"type":"link","label":"DropCourse","href":"/examples/group-by/course/mutations/drop-course","docId":"course/mutations/drop-course","unlisted":false}],"href":"/examples/group-by/category/mutations"},{"type":"category","label":"Queries","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"allCourses","href":"/examples/group-by/course/queries/all-courses","docId":"course/queries/all-courses","unlisted":false},{"type":"link","label":"Course","href":"/examples/group-by/course/queries/course","docId":"course/queries/course","unlisted":false}],"href":"/examples/group-by/category/queries-1"}],"href":"/examples/group-by/category/course"},{"type":"category","label":"Grade","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"Mutations","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"UpdateGPA","href":"/examples/group-by/grade/mutations/update-gpa","docId":"grade/mutations/update-gpa","unlisted":false},{"type":"link","label":"UpdateGrade","href":"/examples/group-by/grade/mutations/update-grade","docId":"grade/mutations/update-grade","unlisted":false}],"href":"/examples/group-by/category/mutations-1"},{"type":"category","label":"Queries","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"GPA","href":"/examples/group-by/grade/queries/gpa","docId":"grade/queries/gpa","unlisted":false},{"type":"link","label":"UnWeightedGPA","href":"/examples/group-by/grade/queries/un-weighted-gpa","docId":"grade/queries/un-weighted-gpa","unlisted":false},{"type":"link","label":"WeightedGPA","href":"/examples/group-by/grade/queries/weighted-gpa","docId":"grade/queries/weighted-gpa","unlisted":false}],"href":"/examples/group-by/category/queries-2"}],"href":"/examples/group-by/category/grade"},{"type":"link","label":"Schema Documentation","href":"/examples/group-by/","className":"navbar__toggle","docId":"schema","unlisted":false},{"type":"category","label":"Deprecated","collapsible":true,"collapsed":true,"className":"deprecated","items":[{"type":"category","label":"Course","collapsible":true,"collapsed":true,"items":[{"type":"category","label":"Queries","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"mathCourses","href":"/examples/group-by/deprecated/course/queries/math-courses","docId":"deprecated/course/queries/math-courses","unlisted":false},{"type":"link","label":"scienceCourses","href":"/examples/group-by/deprecated/course/queries/science-courses","docId":"deprecated/course/queries/science-courses","unlisted":false}],"href":"/examples/group-by/category/queries-3"}],"href":"/examples/group-by/category/course-1"}],"href":"/examples/group-by/category/deprecated"}]},"docs":{"common/directives/auth":{"id":"common/directives/auth","title":"auth","description":"Example of custom directive for customDirective descriptor.","sidebar":"schemaSidebar"},"common/directives/beta":{"id":"common/directives/beta","title":"beta","description":"Example of custom directive for customDirective tag.","sidebar":"schemaSidebar"},"common/directives/complexity":{"id":"common/directives/complexity","title":"complexity","description":"Example of custom directive for customDirective.","sidebar":"schemaSidebar"},"common/directives/deprecated":{"id":"common/directives/deprecated","title":"deprecated","description":"Marks an element of a GraphQL schema as no longer supported.","sidebar":"schemaSidebar"},"common/directives/doc":{"id":"common/directives/doc","title":"doc","description":"Example of custom directive for groupByDirective.","sidebar":"schemaSidebar"},"common/directives/example":{"id":"common/directives/example","title":"example","description":"Example of example directive for exampleSection.","sidebar":"schemaSidebar"},"common/directives/include":{"id":"common/directives/include","title":"include","description":"Directs the executor to include this field or fragment only when the if argument is true.","sidebar":"schemaSidebar"},"common/directives/no-doc":{"id":"common/directives/no-doc","title":"noDoc","description":"Example of custom directive for skipDocDirective.","sidebar":"schemaSidebar"},"common/directives/one-of":{"id":"common/directives/one-of","title":"oneOf","description":"Indicates exactly one field must be supplied and this field must not be null.","sidebar":"schemaSidebar"},"common/directives/skip":{"id":"common/directives/skip","title":"skip","description":"Directs the executor to skip this field or fragment when the if argument is true.","sidebar":"schemaSidebar"},"common/directives/specified-by":{"id":"common/directives/specified-by","title":"specifiedBy","description":"Exposes a URL that specifies the behavior of this scalar.","sidebar":"schemaSidebar"},"common/enums/roles":{"id":"common/enums/roles","title":"Roles","description":"No description","sidebar":"schemaSidebar"},"common/interfaces/record":{"id":"common/interfaces/record","title":"Record","description":"No description","sidebar":"schemaSidebar"},"common/objects/course":{"id":"common/objects/course","title":"Course","description":"No description","sidebar":"schemaSidebar"},"common/objects/department-information":{"id":"common/objects/department-information","title":"DepartmentInformation","description":"No description","sidebar":"schemaSidebar"},"common/objects/semester":{"id":"common/objects/semester","title":"Semester","description":"No description","sidebar":"schemaSidebar"},"common/queries/search-role":{"id":"common/queries/search-role","title":"searchRole","description":"No description","sidebar":"schemaSidebar"},"common/scalars/boolean":{"id":"common/scalars/boolean","title":"Boolean","description":"The Boolean scalar type represents true or false.","sidebar":"schemaSidebar"},"common/scalars/date":{"id":"common/scalars/date","title":"Date","description":"No description","sidebar":"schemaSidebar"},"common/scalars/email-address":{"id":"common/scalars/email-address","title":"EmailAddress","description":"No description","sidebar":"schemaSidebar"},"common/scalars/id":{"id":"common/scalars/id","title":"ID","description":"The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as \\"4\\") or integer (such as 4) input value will be accepted as an ID.","sidebar":"schemaSidebar"},"common/scalars/int":{"id":"common/scalars/int","title":"Int","description":"The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.","sidebar":"schemaSidebar"},"common/scalars/phone-number":{"id":"common/scalars/phone-number","title":"PhoneNumber","description":"No description","sidebar":"schemaSidebar"},"common/scalars/string":{"id":"common/scalars/string","title":"String","description":"The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.","sidebar":"schemaSidebar"},"common/scalars/time":{"id":"common/scalars/time","title":"Time","description":"No description","sidebar":"schemaSidebar"},"common/scalars/url":{"id":"common/scalars/url","title":"URL","description":"No description","sidebar":"schemaSidebar"},"course/mutations/add-course":{"id":"course/mutations/add-course","title":"AddCourse","description":"No description","sidebar":"schemaSidebar"},"course/mutations/drop-course":{"id":"course/mutations/drop-course","title":"DropCourse","description":"No description","sidebar":"schemaSidebar"},"course/queries/all-courses":{"id":"course/queries/all-courses","title":"allCourses","description":"List of courses available.","sidebar":"schemaSidebar"},"course/queries/course":{"id":"course/queries/course","title":"Course","description":"No description","sidebar":"schemaSidebar"},"deprecated/course/queries/math-courses":{"id":"deprecated/course/queries/math-courses","title":"mathCourses","description":"No longer supported","sidebar":"schemaSidebar"},"deprecated/course/queries/science-courses":{"id":"deprecated/course/queries/science-courses","title":"scienceCourses","description":"No longer supported","sidebar":"schemaSidebar"},"grade/mutations/update-gpa":{"id":"grade/mutations/update-gpa","title":"UpdateGPA","description":"No description","sidebar":"schemaSidebar"},"grade/mutations/update-grade":{"id":"grade/mutations/update-grade","title":"UpdateGrade","description":"No description","sidebar":"schemaSidebar"},"grade/queries/gpa":{"id":"grade/queries/gpa","title":"GPA","description":"No description","sidebar":"schemaSidebar"},"grade/queries/un-weighted-gpa":{"id":"grade/queries/un-weighted-gpa","title":"UnWeightedGPA","description":"No description","sidebar":"schemaSidebar"},"grade/queries/weighted-gpa":{"id":"grade/queries/weighted-gpa","title":"WeightedGPA","description":"No description","sidebar":"schemaSidebar"},"schema":{"id":"schema","title":"Schema Documentation","description":"This is an example of documentation grouping with GraphQL directive using the groupByDirective option (see documentation):","sidebar":"schemaSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/27b16d00.861a1040.js b/assets/js/27b16d00.861a1040.js new file mode 100644 index 000000000..88804c50f --- /dev/null +++ b/assets/js/27b16d00.861a1040.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[3399],{95963:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>l,default:()=>p,frontMatter:()=>s,metadata:()=>d,toc:()=>c});var t=r(74848),i=r(28453);const s={title:"object",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},l=void 0,d={id:"printer-legacy/graphql/object",title:"object",description:"printCodeObject()",source:"@site/api/printer-legacy/graphql/object.md",sourceDirName:"printer-legacy/graphql",slug:"/printer-legacy/graphql/object",permalink:"/api/printer-legacy/graphql/object",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"object",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},a={},c=[{value:"printCodeObject()",id:"printcodeobject",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"printCodeType()",id:"printcodetype",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3},{value:"printObjectMetadata()",id:"printobjectmetadata",level:2},{value:"Parameters",id:"parameters-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Defined in",id:"defined-in-2",level:3}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"printcodeobject",children:"printCodeObject()"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function printCodeObject(type, options): string\n"})}),"\n",(0,t.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"type"}),": ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options"}),": ",(0,t.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,t.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"string"})}),"\n",(0,t.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/graphql/object.ts#L74",children:"graphql/object.ts:74"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"printcodetype",children:"printCodeType()"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function printCodeType(\n type, \n entity, \n options): string\n"})}),"\n",(0,t.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"type"}),": ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"entity"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options"}),": ",(0,t.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,t.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"string"})}),"\n",(0,t.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/graphql/object.ts#L40",children:"graphql/object.ts:40"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"printobjectmetadata",children:"printObjectMetadata()"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function printObjectMetadata(type, options): string\n"})}),"\n",(0,t.jsx)(n.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"type"}),": ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options"}),": ",(0,t.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,t.jsx)(n.h3,{id:"returns-2",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"string"})}),"\n",(0,t.jsx)(n.h3,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/graphql/object.ts#L25",children:"graphql/object.ts:25"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>d});var t=r(96540);const i={},s=t.createContext(i);function l(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/287d049f.60375e54.js b/assets/js/287d049f.60375e54.js new file mode 100644 index 000000000..c1b56ab1b --- /dev/null +++ b/assets/js/287d049f.60375e54.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[373],{34567:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>s,default:()=>c,frontMatter:()=>a,metadata:()=>o,toc:()=>d});var i=r(74848),t=r(28453);const a={title:"operation",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},s=void 0,o={id:"printer-legacy/graphql/operation",title:"operation",description:"printCodeOperation()",source:"@site/api/printer-legacy/graphql/operation.md",sourceDirName:"printer-legacy/graphql",slug:"/printer-legacy/graphql/operation",permalink:"/api/printer-legacy/graphql/operation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"operation",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},l={},d=[{value:"printCodeOperation()",id:"printcodeoperation",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"printOperationMetadata()",id:"printoperationmetadata",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3},{value:"printOperationType()",id:"printoperationtype",level:2},{value:"Parameters",id:"parameters-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Defined in",id:"defined-in-2",level:3}];function p(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"printcodeoperation",children:"printCodeOperation()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printCodeOperation(\n type, \n options?, \n indentationLevel?): string | MDXString\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"indentationLevel?"}),": ",(0,i.jsx)(n.code,{children:"number"})," = ",(0,i.jsx)(n.code,{children:"0"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/graphql/operation.ts#L37",children:"graphql/operation.ts:37"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"printoperationmetadata",children:"printOperationMetadata()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printOperationMetadata(type, options): string | MDXString\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/graphql/operation.ts#L23",children:"graphql/operation.ts:23"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"printoperationtype",children:"printOperationType()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printOperationType(type, options): string | MDXString\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/graphql/operation.ts#L8",children:"graphql/operation.ts:8"})})]})}function c(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>o});var i=r(96540);const t={},a=i.createContext(t);function s(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2c24e59e.7100aa87.js b/assets/js/2c24e59e.7100aa87.js new file mode 100644 index 000000000..1ed0e6413 --- /dev/null +++ b/assets/js/2c24e59e.7100aa87.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[524],{67824:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>t,metadata:()=>l,toc:()=>a});var i=r(74848),s=r(28453);const t={title:"printer",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},d=void 0,l={id:"printer-legacy/printer",title:"printer",description:"Printer",source:"@site/api/printer-legacy/printer.md",sourceDirName:"printer-legacy",slug:"/printer-legacy/printer",permalink:"/api/printer-legacy/printer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"printer",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},c={},a=[{value:"Printer",id:"printer",level:2},{value:"Implements",id:"implements",level:3},{value:"Constructors",id:"constructors",level:3},{value:"new Printer()",id:"new-printer",level:4},{value:"Returns",id:"returns",level:5},{value:"Properties",id:"properties",level:3},{value:"options",id:"options",level:4},{value:"Defined in",id:"defined-in",level:5},{value:"printCustomDirectives()",id:"printcustomdirectives",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Defined in",id:"defined-in-1",level:5},{value:"printCustomTags()",id:"printcustomtags",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-2",level:5},{value:"Defined in",id:"defined-in-2",level:5},{value:"printDescription()",id:"printdescription",level:4},{value:"Parameters",id:"parameters-2",level:5},{value:"Returns",id:"returns-3",level:5},{value:"Defined in",id:"defined-in-3",level:5},{value:"Methods",id:"methods",level:3},{value:"init()",id:"init",level:4},{value:"Parameters",id:"parameters-3",level:5},{value:"Returns",id:"returns-4",level:5},{value:"Defined in",id:"defined-in-4",level:5},{value:"printCode()",id:"printcode",level:4},{value:"Parameters",id:"parameters-4",level:5},{value:"Returns",id:"returns-5",level:5},{value:"Defined in",id:"defined-in-5",level:5},{value:"printExample()",id:"printexample",level:4},{value:"Parameters",id:"parameters-5",level:5},{value:"Returns",id:"returns-6",level:5},{value:"Defined in",id:"defined-in-6",level:5},{value:"printHeader()",id:"printheader",level:4},{value:"Parameters",id:"parameters-6",level:5},{value:"Returns",id:"returns-7",level:5},{value:"Defined in",id:"defined-in-7",level:5},{value:"printMetaTags()",id:"printmetatags",level:4},{value:"Parameters",id:"parameters-7",level:5},{value:"Returns",id:"returns-8",level:5},{value:"Defined in",id:"defined-in-8",level:5},{value:"printRelations()",id:"printrelations",level:4},{value:"Parameters",id:"parameters-8",level:5},{value:"Returns",id:"returns-9",level:5},{value:"Defined in",id:"defined-in-9",level:5},{value:"printType()",id:"printtype",level:4},{value:"Parameters",id:"parameters-9",level:5},{value:"Returns",id:"returns-10",level:5},{value:"Defined in",id:"defined-in-10",level:5},{value:"printTypeMetadata()",id:"printtypemetadata",level:4},{value:"Parameters",id:"parameters-10",level:5},{value:"Returns",id:"returns-11",level:5},{value:"Defined in",id:"defined-in-11",level:5}];function h(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",h5:"h5",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"printer",children:"Printer"}),"\n",(0,i.jsx)(n.h3,{id:"implements",children:"Implements"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.code,{children:"IPrinter"})}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"constructors",children:"Constructors"}),"\n",(0,i.jsx)(n.h4,{id:"new-printer",children:"new Printer()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"new Printer(): Printer\n"})}),"\n",(0,i.jsx)(n.h5,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/printer-legacy/printer#printer",children:(0,i.jsx)(n.code,{children:"Printer"})})}),"\n",(0,i.jsx)(n.h3,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(n.h4,{id:"options",children:"options"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"static options: Readonly>;\n"})}),"\n",(0,i.jsx)(n.h5,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/printer.ts#L66",children:"printer.ts:66"})}),"\n",(0,i.jsx)(n.h4,{id:"printcustomdirectives",children:"printCustomDirectives()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"readonly static printCustomDirectives: (type, options) => string;\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsx)(n.h5,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/printer.ts#L70",children:"printer.ts:70"})}),"\n",(0,i.jsx)(n.h4,{id:"printcustomtags",children:"printCustomTags()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"readonly static printCustomTags: (type, options) => string | MDXString;\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,i.jsx)(n.h5,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/printer.ts#L72",children:"printer.ts:72"})}),"\n",(0,i.jsx)(n.h4,{id:"printdescription",children:"printDescription()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"readonly static printDescription: (type, options?, noText?) => string | MDXString;\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"noText?"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-3",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,i.jsx)(n.h5,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/printer.ts#L68",children:"printer.ts:68"})}),"\n",(0,i.jsx)(n.h3,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(n.h4,{id:"init",children:"init()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"static init(\n schema, \n baseURL, \n linkRoot, \n __namedParameters): void\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-3",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"schema"}),": ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"GraphQLSchema"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"baseURL"}),": ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"string"}),"> = ",(0,i.jsx)(n.code,{children:'"schema"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"linkRoot"}),": ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"string"}),"> = ",(0,i.jsx)(n.code,{children:'"/"'})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"__namedParameters"})," = ",(0,i.jsx)(n.code,{children:"..."})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"__namedParameters.customDirectives?"}),": ",(0,i.jsx)(n.code,{children:"CustomDirectiveMap"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"__namedParameters.deprecated?"}),": ",(0,i.jsx)(n.code,{children:"TypeDeprecatedOption"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"__namedParameters.groups?"}),": ",(0,i.jsx)(n.code,{children:"Partial"}),"<",(0,i.jsx)(n.code,{children:"Record"}),"<",(0,i.jsx)(n.code,{children:"SchemaEntity"}),", ",(0,i.jsx)(n.code,{children:"Record"}),"<",(0,i.jsx)(n.code,{children:"string"}),", ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"string"}),">>>>"]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"__namedParameters.metatags?"}),": ",(0,i.jsx)(n.code,{children:"Record"}),"<",(0,i.jsx)(n.code,{children:"string"}),", ",(0,i.jsx)(n.code,{children:"string"}),">[]"]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"__namedParameters.onlyDocDirectives?"}),": ",(0,i.jsx)(n.code,{children:"GraphQLDirective"}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"__namedParameters.printTypeOptions?"}),": ",(0,i.jsx)(n.code,{children:"PrinterConfigPrintTypeOptions"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"__namedParameters.skipDocDirectives?"}),": ",(0,i.jsx)(n.code,{children:"GraphQLDirective"}),"[]"]}),"\n",(0,i.jsx)(n.h5,{id:"returns-4",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"void"})}),"\n",(0,i.jsx)(n.h5,{id:"defined-in-4",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/printer.ts#L74",children:"printer.ts:74"})}),"\n",(0,i.jsx)(n.h4,{id:"printcode",children:"printCode()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"readonly static printCode(type, options): string\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-4",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-5",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsx)(n.h5,{id:"defined-in-5",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/printer.ts#L141",children:"printer.ts:141"})}),"\n",(0,i.jsx)(n.h4,{id:"printexample",children:"printExample()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"readonly static printExample(type, options): string\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-5",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-6",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsx)(n.h5,{id:"defined-in-6",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/printer.ts#L186",children:"printer.ts:186"})}),"\n",(0,i.jsx)(n.h4,{id:"printheader",children:"printHeader()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"readonly static printHeader(\n id, \n title, \n options): string\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-6",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"title"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-7",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsx)(n.h5,{id:"defined-in-7",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/printer.ts#L131",children:"printer.ts:131"})}),"\n",(0,i.jsx)(n.h4,{id:"printmetatags",children:"printMetaTags()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"readonly static printMetaTags(_type, __namedParameters): string | MDXString\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-7",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"_type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"__namedParameters"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-8",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,i.jsx)(n.h5,{id:"defined-in-8",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/printer.ts#L246",children:"printer.ts:246"})}),"\n",(0,i.jsx)(n.h4,{id:"printrelations",children:"printRelations()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"readonly static printRelations(type, options): string | MDXString\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-8",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-9",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,i.jsx)(n.h5,{id:"defined-in-9",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/printer.ts#L236",children:"printer.ts:236"})}),"\n",(0,i.jsx)(n.h4,{id:"printtype",children:"printType()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"readonly static printType(\n name, \n type, \noptions?): Maybe\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-9",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"Partial"}),"<",(0,i.jsx)(n.code,{children:"PrintTypeOptions"}),">>"]}),"\n",(0,i.jsx)(n.h5,{id:"returns-10",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"MDXString"}),">"]}),"\n",(0,i.jsx)(n.h5,{id:"defined-in-10",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/printer.ts#L265",children:"printer.ts:265"})}),"\n",(0,i.jsx)(n.h4,{id:"printtypemetadata",children:"printTypeMetadata()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"readonly static printTypeMetadata(type, options): string | MDXString\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-10",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-11",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,i.jsx)(n.h5,{id:"defined-in-11",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/printer.ts#L207",children:"printer.ts:207"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>d,x:()=>l});var i=r(96540);const s={},t=i.createContext(s);function d(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2e57b0d8.f2287ffd.js b/assets/js/2e57b0d8.f2287ffd.js new file mode 100644 index 000000000..ac0dfbe1a --- /dev/null +++ b/assets/js/2e57b0d8.f2287ffd.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[8002],{80074:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>p,contentTitle:()=>l,default:()=>o,frontMatter:()=>a,metadata:()=>s,toc:()=>c});var i=r(74848),t=r(28453);const a={title:"example",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},l=void 0,s={id:"printer-legacy/example",title:"example",description:"getDirectiveExampleOption()",source:"@site/api/printer-legacy/example.md",sourceDirName:"printer-legacy",slug:"/printer-legacy/example",permalink:"/api/printer-legacy/example",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"example",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},p={},c=[{value:"getDirectiveExampleOption()",id:"getdirectiveexampleoption",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"printExample()",id:"printexample",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3}];function d(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"getdirectiveexampleoption",children:"getDirectiveExampleOption()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function getDirectiveExampleOption(options): Maybe\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"TypeDirectiveExample"}),">"]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/example.ts#L29",children:"example.ts:29"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"printexample",children:"printExample()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printExample(type, options): Maybe\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/example.ts#L172",children:"example.ts:172"})})]})}function o(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>s});var i=r(96540);const t={},a=i.createContext(t);function l(e){const n=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:l(e.components),i.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4ea83d6a.97829d76.js b/assets/js/4ea83d6a.97829d76.js new file mode 100644 index 000000000..eae67d371 --- /dev/null +++ b/assets/js/4ea83d6a.97829d76.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[4775],{9438:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>h,frontMatter:()=>l,metadata:()=>d,toc:()=>c});var s=i(74848),r=i(28453);const l={title:"fs",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},t=void 0,d={id:"utils/fs",title:"fs",description:"Library of helper functions for handling files and folders.",source:"@site/api/utils/fs.md",sourceDirName:"utils",slug:"/utils/fs",permalink:"/api/utils/fs",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"fs",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},a={},c=[{value:"ensureDir()",id:"ensuredir",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"fileExists()",id:"fileexists",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3},{value:"saveFile()",id:"savefile",level:2},{value:"Parameters",id:"parameters-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Defined in",id:"defined-in-2",level:3}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.p,{children:"Library of helper functions for handling files and folders."}),"\n",(0,s.jsx)(n.h2,{id:"ensuredir",children:"ensureDir()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function ensureDir(location): Promise\n"})}),"\n",(0,s.jsx)(n.p,{children:"Asynchronously create a folder structure if it does not exist."}),"\n",(0,s.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"location"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"folder structure in path format."}),"\n",(0,s.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/utils/src/fs.ts#L57",children:"fs.ts:57"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"fileexists",children:"fileExists()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function fileExists(location): Promise\n"})}),"\n",(0,s.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"location"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"file or folder location."}),"\n",(0,s.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"true"})," if the path is valid, else ",(0,s.jsx)(n.code,{children:"false"})," if not."]}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/utils/src/fs.ts#L32",children:"fs.ts:32"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"savefile",children:"saveFile()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function saveFile(\n location, \n content, \nprettify?): Promise\n"})}),"\n",(0,s.jsx)(n.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"location"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"file location."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"content"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"data to be written into the file (UTF-8 string)."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"prettify?"}),": ",(0,s.jsx)(n.code,{children:"PrettifyCallbackFunction"})]}),"\n",(0,s.jsx)(n.p,{children:"optional callback function for prettifying the content."}),"\n",(0,s.jsx)(n.h3,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"Promise"}),"<",(0,s.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.code,{children:"true"})," if the path is valid, else ",(0,s.jsx)(n.code,{children:"false"})," if not."]}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/utils/src/fs.ts#L85",children:"fs.ts:85"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},28453:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>d});var s=i(96540);const r={},l=s.createContext(r);function t(e){const n=s.useContext(l);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),s.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/50c19381.f66fcf75.js b/assets/js/50c19381.f66fcf75.js new file mode 100644 index 000000000..c7ef8f6c1 --- /dev/null +++ b/assets/js/50c19381.f66fcf75.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[2113],{62079:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>o});var r=i(74848),t=i(28453);const s={title:"descriptor",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},d=void 0,c={id:"helpers/directives/descriptor",title:"descriptor",description:"Custom directive descriptor helper.",source:"@site/api/helpers/directives/descriptor.md",sourceDirName:"helpers/directives",slug:"/helpers/directives/descriptor",permalink:"/api/helpers/directives/descriptor",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"descriptor",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},a={},o=[{value:"See",id:"see",level:2},{value:"directiveDescriptor()",id:"directivedescriptor",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Example",id:"example",level:3},{value:"Defined in",id:"defined-in",level:3}];function l(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsxs)(n.p,{children:["Custom directive ",(0,r.jsx)(n.code,{children:"descriptor"})," helper."]}),"\n",(0,r.jsx)(n.h2,{id:"see",children:"See"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsxs)(n.a,{href:"https://graphql-markdown.dev/docs/advanced/custom-directive#descriptor",children:["Option ",(0,r.jsx)(n.code,{children:"customDirective.[directive].descriptor"})]})}),"\n",(0,r.jsx)(n.h2,{id:"directivedescriptor",children:"directiveDescriptor()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function directiveDescriptor(\n directive, \n type?, \n descriptionTemplate?): string\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Helper for rendering custom description from schema directive on type.\nThis is an example on how to build a custom ",(0,r.jsx)(n.code,{children:"descriptor"})," callback."]}),"\n",(0,r.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"directive"}),": ",(0,r.jsx)(n.code,{children:"GraphQLDirective"})]}),"\n",(0,r.jsx)(n.p,{children:"the schema directive to parse."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"type?"}),": ",(0,r.jsx)(n.code,{children:"unknown"})]}),"\n",(0,r.jsx)(n.p,{children:"the schema type to be processed for generating a custom description."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"descriptionTemplate?"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsxs)(n.p,{children:["optional template literal-like string for rendering the description (see ",(0,r.jsx)(n.a,{href:"/api/helpers/utils/interpolate#interpolate",children:"interpolate"}),"), if not present then the directive description will be used."]}),"\n",(0,r.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.p,{children:"a custom description based on directive value."}),"\n",(0,r.jsx)(n.h3,{id:"example",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-js",children:'import { GraphQLDirective, GraphQLScalarType } from "graphql";\nimport { directiveDescriptor } from "@graphql-markdown/helpers/directives/descriptor";\n\nconst directive = new GraphQLDirective({\n name: "version",\n description: "Min version",\n locations: [],\n args: {\n major: { type: GraphQLInt, defaultValue: 0 },\n minor: { type: GraphQLInt, defaultValue: 0 },\n patch: { type: GraphQLInt, defaultValue: 0 },\n },\n});\n\nconst type = new GraphQLScalarType({\n name: "FooBar",\n astNode: {\n kind: Kind.SCALAR_TYPE_DEFINITION,\n name: { kind: Kind.NAME, value: "FooBar" },\n directives: [\n {\n kind: Kind.DIRECTIVE,\n name: { kind: Kind.NAME, value: "version" },\n arguments: [\n {\n kind: Kind.ARGUMENT,\n name: { kind: Kind.NAME, value: "major" },\n value: { kind: Kind.INT, value: "2" },\n },\n {\n kind: Kind.ARGUMENT,\n name: { kind: Kind.NAME, value: "minor" },\n value: { kind: Kind.INT, value: "1" },\n },\n {\n kind: Kind.ARGUMENT,\n name: { kind: Kind.NAME, value: "patch" },\n value: { kind: Kind.INT, value: "3" },\n },\n ],\n },\n ],\n },\n});\n\ndirectiveDescriptor(directive, type, "${description} is ${major}.${minor}.${patch}");\n// Expected result: "Min version is 2.1.3"\n\ndirectiveDescriptor(directive, type);\n// Expected result: "Min version"\n\ndirectiveDescriptor(directive, type, "Version should be at least ^${major}.${minor}.${patch}");\n// Expected result: "Version should be at least ^2.1.3"\n'})}),"\n",(0,r.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/helpers/src/directives/descriptor.ts#L83",children:"directives/descriptor.ts:83"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},28453:(e,n,i)=>{i.d(n,{R:()=>d,x:()=>c});var r=i(96540);const t={},s=r.createContext(t);function d(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:d(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/5c7c1faa.8ba54d84.js b/assets/js/5c7c1faa.8ba54d84.js new file mode 100644 index 000000000..74006cf6f --- /dev/null +++ b/assets/js/5c7c1faa.8ba54d84.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[5754],{6364:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>o,contentTitle:()=>a,default:()=>p,frontMatter:()=>i,metadata:()=>s,toc:()=>c});var r=t(74848),l=t(28453);const i={title:"interpolate",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},a=void 0,s={id:"helpers/utils/interpolate",title:"interpolate",description:"Helpers utility functions library.",source:"@site/api/helpers/utils/interpolate.md",sourceDirName:"helpers/utils",slug:"/helpers/utils/interpolate",permalink:"/api/helpers/utils/interpolate",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"interpolate",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},o={},c=[{value:"getObjPath()",id:"getobjpath",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Example",id:"example",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"interpolate()",id:"interpolate",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Example",id:"example-1",level:3},{value:"Defined in",id:"defined-in-1",level:3}];function d(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,l.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"Helpers utility functions library."}),"\n",(0,r.jsx)(n.h2,{id:"getobjpath",children:"getObjPath()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function getObjPath(\n path, \n obj, \n fallback): unknown\n"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"Internal"})})}),"\n",(0,r.jsx)(n.p,{children:"Returns the value of the specified property or nested property of an object using a string path."}),"\n",(0,r.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"path"}),": ",(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,r.jsx)(n.p,{children:"property path as string."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"obj"}),": ",(0,r.jsx)(n.code,{children:"unknown"})]}),"\n",(0,r.jsx)(n.p,{children:"the key/value record object."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"fallback"}),": ",(0,r.jsx)(n.code,{children:"unknown"})," = ",(0,r.jsx)(n.code,{children:'""'})]}),"\n",(0,r.jsx)(n.p,{children:"optional fallback value to be returned if the path cannot be resolved."}),"\n",(0,r.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"unknown"})}),"\n",(0,r.jsxs)(n.p,{children:["the property value if the path is resolved, else returns the ",(0,r.jsx)(n.code,{children:"fallback"})," value."]}),"\n",(0,r.jsx)(n.h3,{id:"example",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-js",children:'import { getObjPath } from \'@graphql-markdown/utils/object\';\n\ngetObjPath("foo.bar", { foo: { bar: 42 } }); // Returns 42\n\ngetObjPath("foo.bak", { foo: { bar: 42 } }, "fallback"); // Returns "fallback"\n'})}),"\n",(0,r.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/helpers/src/utils/interpolate.ts#L31",children:"utils/interpolate.ts:31"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h2,{id:"interpolate",children:"interpolate()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function interpolate(\n template, \n variables, \n fallback?): string\n"})}),"\n",(0,r.jsx)(n.p,{children:"Interpolate a template literal-like string."}),"\n",(0,r.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"template"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"a string template literal-like."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"variables"}),": ",(0,r.jsx)(n.code,{children:"Maybe"}),"<",(0,r.jsx)(n.code,{children:"Record"}),"<",(0,r.jsx)(n.code,{children:"string"}),", ",(0,r.jsx)(n.code,{children:"unknown"}),"> & ",(0,r.jsx)(n.code,{children:"object"}),">"]}),"\n",(0,r.jsxs)(n.p,{children:["a record map of values with variable's name as key and ",(0,r.jsx)(n.code,{children:"description"})," as directive's description."]}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"fallback?"}),": ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.p,{children:"optional fallback value if a variable cannot be substituted."}),"\n",(0,r.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.p,{children:"an interpolated new string from the template."}),"\n",(0,r.jsx)(n.h3,{id:"example-1",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-js",children:'const values = { foo: 42, bar: { value: "test" } };\nconst template = "${foo} is not ${bar.notfound}";\n\ninterpolate(template, values, "fallback"); // Expected result: "42 is not fallback",\n'})}),"\n",(0,r.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/helpers/src/utils/interpolate.ts#L64",children:"utils/interpolate.ts:64"})})]})}function p(e={}){const{wrapper:n}={...(0,l.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},28453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>s});var r=t(96540);const l={},i=r.createContext(l);function a(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(l):e.components||l:a(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/65ff014b.43b280a3.js b/assets/js/65ff014b.43b280a3.js new file mode 100644 index 000000000..a4f6c897e --- /dev/null +++ b/assets/js/65ff014b.43b280a3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[415],{28402:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>l,default:()=>p,frontMatter:()=>s,metadata:()=>a,toc:()=>d});var t=r(74848),i=r(28453);const s={title:"relation",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},l=void 0,a={id:"printer-legacy/relation",title:"relation",description:"getRootTypeLocaleFromString()",source:"@site/api/printer-legacy/relation.md",sourceDirName:"printer-legacy",slug:"/printer-legacy/relation",permalink:"/api/printer-legacy/relation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"relation",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},o={},d=[{value:"getRootTypeLocaleFromString()",id:"getroottypelocalefromstring",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"printRelationOf()",id:"printrelationof",level:2},{value:"Type Parameters",id:"type-parameters",level:3},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3},{value:"printRelations()",id:"printrelations",level:2},{value:"Parameters",id:"parameters-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Defined in",id:"defined-in-2",level:3}];function c(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"getroottypelocalefromstring",children:"getRootTypeLocaleFromString()"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function getRootTypeLocaleFromString(text): Maybe\n"})}),"\n",(0,t.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"text"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Maybe"}),"<",(0,t.jsx)(n.code,{children:"TypeLocale"}),">"]}),"\n",(0,t.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/relation.ts#L25",children:"relation.ts:25"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"printrelationof",children:"printRelationOf()"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function printRelationOf(\n type, \n section, \n getRelation, \n options): string | MDXString\n"})}),"\n",(0,t.jsx)(n.h3,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"T"})]}),"\n",(0,t.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"type"}),": ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"section"}),": ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"getRelation"}),": ",(0,t.jsx)(n.code,{children:"Maybe"}),"<",(0,t.jsx)(n.code,{children:"IGetRelation"}),"<",(0,t.jsx)(n.code,{children:"T"}),">>"]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options"}),": ",(0,t.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,t.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,t.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/relation.ts#L36",children:"relation.ts:36"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"printrelations",children:"printRelations()"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function printRelations(type, options): string | MDXString\n"})}),"\n",(0,t.jsx)(n.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"type"}),": ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options"}),": ",(0,t.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,t.jsx)(n.h3,{id:"returns-2",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,t.jsx)(n.h3,{id:"defined-in-2",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/relation.ts#L91",children:"relation.ts:91"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>a});var t=r(96540);const i={},s=t.createContext(i);function l(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/67c5b3f9.4c2aed9d.js b/assets/js/67c5b3f9.4c2aed9d.js new file mode 100644 index 000000000..17feb160f --- /dev/null +++ b/assets/js/67c5b3f9.4c2aed9d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[1564],{96002:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>p,frontMatter:()=>s,metadata:()=>o,toc:()=>d});var t=r(74848),i=r(28453);const s={title:"frontmatter",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},a=void 0,o={id:"printer-legacy/frontmatter",title:"frontmatter",description:"formatFrontMatterProp()",source:"@site/api/printer-legacy/frontmatter.md",sourceDirName:"printer-legacy",slug:"/printer-legacy/frontmatter",permalink:"/api/printer-legacy/frontmatter",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"frontmatter",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},l={},d=[{value:"formatFrontMatterProp()",id:"formatfrontmatterprop",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"printFrontMatter()",id:"printfrontmatter",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3}];function c(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"formatfrontmatterprop",children:"formatFrontMatterProp()"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function formatFrontMatterProp(\n prop, \n indentation, \n prefix?): string[]\n"})}),"\n",(0,t.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"prop"}),": ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"indentation"}),": ",(0,t.jsx)(n.code,{children:"number"})," = ",(0,t.jsx)(n.code,{children:"0"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"prefix?"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"string"}),"[]"]}),"\n",(0,t.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/frontmatter.ts#L60",children:"frontmatter.ts:60"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"printfrontmatter",children:"printFrontMatter()"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function printFrontMatter(\n id, \n title, \n props?): string\n"})}),"\n",(0,t.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"id"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"title"}),": ",(0,t.jsx)(n.code,{children:"string"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"props?"}),": ",(0,t.jsx)(n.code,{children:"Maybe"}),"<",(0,t.jsx)(n.code,{children:"FrontMatterOptions"}),">"]}),"\n",(0,t.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"string"})}),"\n",(0,t.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/frontmatter.ts#L83",children:"frontmatter.ts:83"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(c,{...e})}):c(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>a,x:()=>o});var t=r(96540);const i={},s=t.createContext(i);function a(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:a(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/690431c1.f73e169e.js b/assets/js/690431c1.f73e169e.js new file mode 100644 index 000000000..5d3377acf --- /dev/null +++ b/assets/js/690431c1.f73e169e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[612],{85444:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>a,contentTitle:()=>l,default:()=>h,frontMatter:()=>s,metadata:()=>t,toc:()=>c});var i=n(74848),d=n(28453);const s={title:"renderer",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},l=void 0,t={id:"core/renderer",title:"renderer",description:"Renderer",source:"@site/api/core/renderer.md",sourceDirName:"core",slug:"/core/renderer",permalink:"/api/core/renderer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"renderer",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},a={},c=[{value:"Renderer",id:"renderer",level:2},{value:"Constructors",id:"constructors",level:3},{value:"new Renderer()",id:"new-renderer",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Defined in",id:"defined-in",level:5},{value:"Properties",id:"properties",level:3},{value:"baseURL",id:"baseurl",level:4},{value:"Defined in",id:"defined-in-1",level:5},{value:"group",id:"group",level:4},{value:"Defined in",id:"defined-in-2",level:5},{value:"options",id:"options",level:4},{value:"Defined in",id:"defined-in-3",level:5},{value:"outputDir",id:"outputdir",level:4},{value:"Defined in",id:"defined-in-4",level:5},{value:"prettify",id:"prettify",level:4},{value:"Defined in",id:"defined-in-5",level:5},{value:"Methods",id:"methods",level:3},{value:"generateCategoryMetafile()",id:"generatecategorymetafile",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Defined in",id:"defined-in-6",level:5},{value:"generateCategoryMetafileType()",id:"generatecategorymetafiletype",level:4},{value:"Parameters",id:"parameters-2",level:5},{value:"Returns",id:"returns-2",level:5},{value:"Defined in",id:"defined-in-7",level:5},{value:"renderHomepage()",id:"renderhomepage",level:4},{value:"Parameters",id:"parameters-3",level:5},{value:"Returns",id:"returns-3",level:5},{value:"Defined in",id:"defined-in-8",level:5},{value:"renderRootTypes()",id:"renderroottypes",level:4},{value:"Parameters",id:"parameters-4",level:5},{value:"Returns",id:"returns-4",level:5},{value:"Defined in",id:"defined-in-9",level:5},{value:"renderSidebar()",id:"rendersidebar",level:4},{value:"Returns",id:"returns-5",level:5},{value:"Defined in",id:"defined-in-10",level:5},{value:"renderTypeEntities()",id:"rendertypeentities",level:4},{value:"Parameters",id:"parameters-5",level:5},{value:"Returns",id:"returns-6",level:5},{value:"Defined in",id:"defined-in-11",level:5}];function o(e){const r={a:"a",code:"code",em:"em",h2:"h2",h3:"h3",h4:"h4",h5:"h5",p:"p",pre:"pre",strong:"strong",...(0,d.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(r.h2,{id:"renderer",children:"Renderer"}),"\n",(0,i.jsx)(r.h3,{id:"constructors",children:"Constructors"}),"\n",(0,i.jsx)(r.h4,{id:"new-renderer",children:"new Renderer()"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"new Renderer(\n printer, \n outputDir, \n baseURL, \n group, \n prettify, \n docOptions): Renderer\n"})}),"\n",(0,i.jsx)(r.h5,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"printer"}),": ",(0,i.jsx)(r.em,{children:"typeof"})," ",(0,i.jsx)(r.code,{children:"IPrinter"})]}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"outputDir"}),": ",(0,i.jsx)(r.code,{children:"string"})]}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"baseURL"}),": ",(0,i.jsx)(r.code,{children:"string"})]}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"group"}),": ",(0,i.jsx)(r.code,{children:"Maybe"}),"<",(0,i.jsx)(r.code,{children:"Partial"}),"<",(0,i.jsx)(r.code,{children:"Record"}),"<",(0,i.jsx)(r.code,{children:"SchemaEntity"}),", ",(0,i.jsx)(r.code,{children:"Record"}),"<",(0,i.jsx)(r.code,{children:"string"}),", ",(0,i.jsx)(r.code,{children:"Maybe"}),"<",(0,i.jsx)(r.code,{children:"string"}),">>>>>"]}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"prettify"}),": ",(0,i.jsx)(r.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"docOptions"}),": ",(0,i.jsx)(r.code,{children:"Maybe"}),"<",(0,i.jsx)(r.code,{children:"RendererDocOptions"}),">"]}),"\n",(0,i.jsx)(r.h5,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"/api/core/renderer#renderer",children:(0,i.jsx)(r.code,{children:"Renderer"})})}),"\n",(0,i.jsx)(r.h5,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/renderer.ts#L47",children:"renderer.ts:47"})}),"\n",(0,i.jsx)(r.h3,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(r.h4,{id:"baseurl",children:"baseURL"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"baseURL: string;\n"})}),"\n",(0,i.jsx)(r.h5,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/renderer.ts#L41",children:"renderer.ts:41"})}),"\n",(0,i.jsx)(r.h4,{id:"group",children:"group"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"group: Maybe>>>>;\n"})}),"\n",(0,i.jsx)(r.h5,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/renderer.ts#L39",children:"renderer.ts:39"})}),"\n",(0,i.jsx)(r.h4,{id:"options",children:"options"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"options: Maybe;\n"})}),"\n",(0,i.jsx)(r.h5,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/renderer.ts#L43",children:"renderer.ts:43"})}),"\n",(0,i.jsx)(r.h4,{id:"outputdir",children:"outputDir"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"outputDir: string;\n"})}),"\n",(0,i.jsx)(r.h5,{id:"defined-in-4",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/renderer.ts#L40",children:"renderer.ts:40"})}),"\n",(0,i.jsx)(r.h4,{id:"prettify",children:"prettify"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"prettify: boolean;\n"})}),"\n",(0,i.jsx)(r.h5,{id:"defined-in-5",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/renderer.ts#L42",children:"renderer.ts:42"})}),"\n",(0,i.jsx)(r.h3,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(r.h4,{id:"generatecategorymetafile",children:"generateCategoryMetafile()"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"generateCategoryMetafile(\n category, \n dirPath, \n sidebarPosition?, \n styleClass?, \noptions?): Promise\n"})}),"\n",(0,i.jsx)(r.h5,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"category"}),": ",(0,i.jsx)(r.code,{children:"string"})]}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"dirPath"}),": ",(0,i.jsx)(r.code,{children:"string"})]}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"sidebarPosition?"}),": ",(0,i.jsx)(r.code,{children:"number"})]}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"styleClass?"}),": ",(0,i.jsx)(r.code,{children:"string"})]}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"options?"})," = ",(0,i.jsx)(r.code,{children:"..."})]}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"options.collapsed?"}),": ",(0,i.jsx)(r.code,{children:"boolean"})]}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"options.collapsible?"}),": ",(0,i.jsx)(r.code,{children:"boolean"})]}),"\n",(0,i.jsx)(r.h5,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.code,{children:"Promise"}),"<",(0,i.jsx)(r.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(r.h5,{id:"defined-in-6",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/renderer.ts#L63",children:"renderer.ts:63"})}),"\n",(0,i.jsx)(r.h4,{id:"generatecategorymetafiletype",children:"generateCategoryMetafileType()"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"generateCategoryMetafileType(\n type, \n name, \nrootTypeName): Promise\n"})}),"\n",(0,i.jsx)(r.h5,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"type"}),": ",(0,i.jsx)(r.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"name"}),": ",(0,i.jsx)(r.code,{children:"string"})]}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"rootTypeName"}),": ",(0,i.jsx)(r.code,{children:"SchemaEntity"})]}),"\n",(0,i.jsx)(r.h5,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.code,{children:"Promise"}),"<",(0,i.jsx)(r.code,{children:"string"}),">"]}),"\n",(0,i.jsx)(r.h5,{id:"defined-in-7",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/renderer.ts#L98",children:"renderer.ts:98"})}),"\n",(0,i.jsx)(r.h4,{id:"renderhomepage",children:"renderHomepage()"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"renderHomepage(homepageLocation): Promise\n"})}),"\n",(0,i.jsx)(r.h5,{id:"parameters-3",children:"Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"homepageLocation"}),": ",(0,i.jsx)(r.code,{children:"string"})]}),"\n",(0,i.jsx)(r.h5,{id:"returns-3",children:"Returns"}),"\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.code,{children:"Promise"}),"<",(0,i.jsx)(r.code,{children:"void"}),">"]}),"\n",(0,i.jsx)(r.h5,{id:"defined-in-8",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/renderer.ts#L248",children:"renderer.ts:248"})}),"\n",(0,i.jsx)(r.h4,{id:"renderroottypes",children:"renderRootTypes()"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"renderRootTypes(rootTypeName, type): Promise[]>>\n"})}),"\n",(0,i.jsx)(r.h5,{id:"parameters-4",children:"Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"rootTypeName"}),": ",(0,i.jsx)(r.code,{children:"SchemaEntity"})]}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"type"}),": ",(0,i.jsx)(r.code,{children:"unknown"})]}),"\n",(0,i.jsx)(r.h5,{id:"returns-4",children:"Returns"}),"\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.code,{children:"Promise"}),"<",(0,i.jsx)(r.code,{children:"Maybe"}),"<",(0,i.jsx)(r.code,{children:"Maybe"}),"<",(0,i.jsx)(r.code,{children:"Category"}),">[]>>"]}),"\n",(0,i.jsx)(r.h5,{id:"defined-in-9",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/renderer.ts#L145",children:"renderer.ts:145"})}),"\n",(0,i.jsx)(r.h4,{id:"rendersidebar",children:"renderSidebar()"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"renderSidebar(): Promise\n"})}),"\n",(0,i.jsx)(r.h5,{id:"returns-5",children:"Returns"}),"\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.code,{children:"Promise"}),"<",(0,i.jsx)(r.code,{children:"string"}),">"]}),"\n",(0,i.jsx)(r.h5,{id:"defined-in-10",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/renderer.ts#L222",children:"renderer.ts:222"})}),"\n",(0,i.jsx)(r.h4,{id:"rendertypeentities",children:"renderTypeEntities()"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"renderTypeEntities(\n dirPath, \n name, \ntype): Promise>\n"})}),"\n",(0,i.jsx)(r.h5,{id:"parameters-5",children:"Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"dirPath"}),": ",(0,i.jsx)(r.code,{children:"string"})]}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"name"}),": ",(0,i.jsx)(r.code,{children:"string"})]}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"type"}),": ",(0,i.jsx)(r.code,{children:"unknown"})]}),"\n",(0,i.jsx)(r.h5,{id:"returns-6",children:"Returns"}),"\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.code,{children:"Promise"}),"<",(0,i.jsx)(r.code,{children:"Maybe"}),"<",(0,i.jsx)(r.code,{children:"Category"}),">>"]}),"\n",(0,i.jsx)(r.h5,{id:"defined-in-11",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/renderer.ts#L174",children:"renderer.ts:174"})})]})}function h(e={}){const{wrapper:r}={...(0,d.R)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},28453:(e,r,n)=>{n.d(r,{R:()=>l,x:()=>t});var i=n(96540);const d={},s=i.createContext(d);function l(e){const r=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function t(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:l(e.components),i.createElement(s.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6b9371a2.12a4b159.js b/assets/js/6b9371a2.12a4b159.js new file mode 100644 index 000000000..27afaf811 --- /dev/null +++ b/assets/js/6b9371a2.12a4b159.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[1466],{36566:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>t,default:()=>o,frontMatter:()=>l,metadata:()=>d,toc:()=>c});var i=r(74848),s=r(28453);const l={title:"link",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},t=void 0,d={id:"printer-legacy/link",title:"link",description:"getCategoryLocale()",source:"@site/api/printer-legacy/link.md",sourceDirName:"printer-legacy",slug:"/printer-legacy/link",permalink:"/api/printer-legacy/link",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"link",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},a={},c=[{value:"getCategoryLocale()",id:"getcategorylocale",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"getLinkApiGroupFolder()",id:"getlinkapigroupfolder",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3},{value:"getLinkCategoryFolder()",id:"getlinkcategoryfolder",level:2},{value:"Parameters",id:"parameters-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Defined in",id:"defined-in-2",level:3},{value:"getLinkDeprecatedFolder()",id:"getlinkdeprecatedfolder",level:2},{value:"Parameters",id:"parameters-3",level:3},{value:"Returns",id:"returns-3",level:3},{value:"Defined in",id:"defined-in-3",level:3},{value:"getRelationLink()",id:"getrelationlink",level:2},{value:"Parameters",id:"parameters-4",level:3},{value:"Returns",id:"returns-4",level:3},{value:"Defined in",id:"defined-in-4",level:3},{value:"hasOptionParentType()",id:"hasoptionparenttype",level:2},{value:"Parameters",id:"parameters-5",level:3},{value:"Returns",id:"returns-5",level:3},{value:"Defined in",id:"defined-in-5",level:3},{value:"hasOptionWithAttributes()",id:"hasoptionwithattributes",level:2},{value:"Parameters",id:"parameters-6",level:3},{value:"Returns",id:"returns-6",level:3},{value:"Defined in",id:"defined-in-6",level:3},{value:"printLink()",id:"printlink",level:2},{value:"Parameters",id:"parameters-7",level:3},{value:"Returns",id:"returns-7",level:3},{value:"Defined in",id:"defined-in-7",level:3},{value:"printLinkAttributes()",id:"printlinkattributes",level:2},{value:"Parameters",id:"parameters-8",level:3},{value:"Returns",id:"returns-8",level:3},{value:"Defined in",id:"defined-in-8",level:3},{value:"printParentLink()",id:"printparentlink",level:2},{value:"Parameters",id:"parameters-9",level:3},{value:"Returns",id:"returns-9",level:3},{value:"Defined in",id:"defined-in-9",level:3},{value:"toLink()",id:"tolink",level:2},{value:"Parameters",id:"parameters-10",level:3},{value:"Returns",id:"returns-10",level:3},{value:"Defined in",id:"defined-in-10",level:3}];function h(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"getcategorylocale",children:"getCategoryLocale()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function getCategoryLocale(type): Maybe\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"TypeLocale"}),">"]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/link.ts#L37",children:"link.ts:37"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"getlinkapigroupfolder",children:"getLinkApiGroupFolder()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function getLinkApiGroupFolder(type): string\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/link.ts#L97",children:"link.ts:97"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"getlinkcategoryfolder",children:"getLinkCategoryFolder()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function getLinkCategoryFolder(type, operationLocale?): Maybe\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"operationLocale?"}),": ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"TypeLocale"}),">"]}),"\n",(0,i.jsx)(n.h3,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/link.ts#L59",children:"link.ts:59"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"getlinkdeprecatedfolder",children:"getLinkDeprecatedFolder()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function getLinkDeprecatedFolder(type, option): string\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-3",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"option"}),": ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"TypeDeprecatedOption"}),">"]}),"\n",(0,i.jsx)(n.h3,{id:"returns-3",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/link.ts#L101",children:"link.ts:101"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"getrelationlink",children:"getRelationLink()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function getRelationLink(\n category, \n type, \noptions): Maybe\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-4",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"category"}),": ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"TypeLocale"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintLinkOptions"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-4",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"TypeLink"}),">"]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-4",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/link.ts#L158",children:"link.ts:158"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"hasoptionparenttype",children:"hasOptionParentType()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function hasOptionParentType(options): boolean\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-5",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintLinkOptions"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-5",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-5",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/link.ts#L88",children:"link.ts:88"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"hasoptionwithattributes",children:"hasOptionWithAttributes()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function hasOptionWithAttributes(options): boolean\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-6",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintLinkOptions"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-6",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-6",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/link.ts#L84",children:"link.ts:84"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"printlink",children:"printLink()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printLink(type, options): string\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-7",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintLinkOptions"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-7",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-7",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/link.ts#L201",children:"link.ts:201"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"printlinkattributes",children:"printLinkAttributes()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printLinkAttributes(type, text): string\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-8",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"text"}),": ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"string"}),"> = ",(0,i.jsx)(n.code,{children:'""'})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-8",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-8",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/link.ts#L174",children:"link.ts:174"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"printparentlink",children:"printParentLink()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printParentLink(type, options): string | MDXString\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-9",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintLinkOptions"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-9",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-9",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/link.ts#L225",children:"link.ts:225"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"tolink",children:"toLink()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function toLink(\n type, \n name, \n operation, \n options): TypeLink\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-10",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"name"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"operation"}),": ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"TypeLocale"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintLinkOptions"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-10",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"TypeLink"})}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-10",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/link.ts#L108",children:"link.ts:108"})})]})}function o(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>t,x:()=>d});var i=r(96540);const s={},l=i.createContext(s);function t(e){const n=i.useContext(l);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:t(e.components),i.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6bfed8d6.d34269ac.js b/assets/js/6bfed8d6.d34269ac.js new file mode 100644 index 000000000..e6fb265c4 --- /dev/null +++ b/assets/js/6bfed8d6.d34269ac.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[5614],{85730:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>t,default:()=>o,frontMatter:()=>d,metadata:()=>a,toc:()=>c});var i=r(74848),s=r(28453);const d={title:"introspection",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},t=void 0,a={id:"graphql/introspection",title:"introspection",description:"Library for introspecting a GraphQL schema.",source:"@site/api/graphql/introspection.md",sourceDirName:"graphql",slug:"/graphql/introspection",permalink:"/api/graphql/introspection",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"introspection",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},l={},c=[{value:"IntrospectionError",id:"introspectionerror",level:2},{value:"Extends",id:"extends",level:3},{value:"Constructors",id:"constructors",level:3},{value:"new IntrospectionError()",id:"new-introspectionerror",level:4},{value:"Parameters",id:"parameters",level:5},{value:"Returns",id:"returns",level:5},{value:"Inherited from",id:"inherited-from",level:5},{value:"Defined in",id:"defined-in",level:5},{value:"new IntrospectionError()",id:"new-introspectionerror-1",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-1",level:5},{value:"Defined in",id:"defined-in-1",level:5},{value:"_getFields()",id:"_getfields",level:2},{value:"Type Parameters",id:"type-parameters",level:3},{value:"Parameters",id:"parameters-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Defined in",id:"defined-in-2",level:3},{value:"getDirective()",id:"getdirective",level:2},{value:"Parameters",id:"parameters-3",level:3},{value:"Returns",id:"returns-3",level:3},{value:"Defined in",id:"defined-in-3",level:3},{value:"getDirectiveLocationForASTPath()",id:"getdirectivelocationforastpath",level:2},{value:"Parameters",id:"parameters-4",level:3},{value:"Returns",id:"returns-4",level:3},{value:"Defined in",id:"defined-in-4",level:3},{value:"getFields()",id:"getfields",level:2},{value:"Parameters",id:"parameters-5",level:3},{value:"Returns",id:"returns-5",level:3},{value:"Defined in",id:"defined-in-5",level:3},{value:"getOperation()",id:"getoperation",level:2},{value:"Parameters",id:"parameters-6",level:3},{value:"Returns",id:"returns-6",level:3},{value:"Defined in",id:"defined-in-6",level:3},{value:"getSchemaMap()",id:"getschemamap",level:2},{value:"Parameters",id:"parameters-7",level:3},{value:"Returns",id:"returns-7",level:3},{value:"Defined in",id:"defined-in-7",level:3},{value:"getTypeDirectiveArgValue()",id:"gettypedirectiveargvalue",level:2},{value:"Parameters",id:"parameters-8",level:3},{value:"Returns",id:"returns-8",level:3},{value:"Defined in",id:"defined-in-8",level:3},{value:"getTypeDirectiveValues()",id:"gettypedirectivevalues",level:2},{value:"Parameters",id:"parameters-9",level:3},{value:"Returns",id:"returns-9",level:3},{value:"Defined in",id:"defined-in-9",level:3},{value:"getTypeFromSchema()",id:"gettypefromschema",level:2},{value:"Type Parameters",id:"type-parameters-1",level:3},{value:"Parameters",id:"parameters-10",level:3},{value:"Returns",id:"returns-10",level:3},{value:"Defined in",id:"defined-in-10",level:3},{value:"getTypeName()",id:"gettypename",level:2},{value:"Parameters",id:"parameters-11",level:3},{value:"Returns",id:"returns-11",level:3},{value:"Defined in",id:"defined-in-11",level:3},{value:"hasAstNode()",id:"hasastnode",level:2},{value:"Type Parameters",id:"type-parameters-2",level:3},{value:"Parameters",id:"parameters-12",level:3},{value:"Returns",id:"returns-12",level:3},{value:"Defined in",id:"defined-in-12",level:3},{value:"hasDirective()",id:"hasdirective",level:2},{value:"Parameters",id:"parameters-13",level:3},{value:"Returns",id:"returns-13",level:3},{value:"Defined in",id:"defined-in-13",level:3},{value:"isValidDirectiveLocation()",id:"isvaliddirectivelocation",level:2},{value:"Parameters",id:"parameters-14",level:3},{value:"Returns",id:"returns-14",level:3},{value:"Defined in",id:"defined-in-14",level:3}];function h(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(n.p,{children:["Library for introspecting a GraphQL schema.\nThe entry point method is ",(0,i.jsx)(n.a,{href:"/api/graphql/introspection#getschemamap",children:"getSchemaMap"}),"."]}),"\n",(0,i.jsx)(n.h2,{id:"introspectionerror",children:"IntrospectionError"}),"\n",(0,i.jsx)(n.h3,{id:"extends",children:"Extends"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.code,{children:"Error"})}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"constructors",children:"Constructors"}),"\n",(0,i.jsx)(n.h4,{id:"new-introspectionerror",children:"new IntrospectionError()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"new IntrospectionError(message?): IntrospectionError\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"message?"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/graphql/introspection#introspectionerror",children:(0,i.jsx)(n.code,{children:"IntrospectionError"})})}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"Error.constructor"})}),"\n",(0,i.jsx)(n.h5,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:"node_modules/typescript/lib/lib.es5.d.ts:1082"}),"\n",(0,i.jsx)(n.h4,{id:"new-introspectionerror-1",children:"new IntrospectionError()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"new IntrospectionError(message?, options?): IntrospectionError\n"})}),"\n",(0,i.jsx)(n.h5,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"message?"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"ErrorOptions"})]}),"\n",(0,i.jsx)(n.h5,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"/api/graphql/introspection#introspectionerror",children:(0,i.jsx)(n.code,{children:"IntrospectionError"})})}),"\n",(0,i.jsx)(n.h5,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"Error.constructor"})}),"\n",(0,i.jsx)(n.h5,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:"node_modules/typescript/lib/lib.es5.d.ts:1082"}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"_getfields",children:"_getFields()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function _getFields(\n type, \n processor?, \n fallback?): GraphQLObjectType | GraphQLFieldMap | GraphQLInputFieldMap | V\n"})}),"\n",(0,i.jsx)(n.h3,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"T"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"V"})]}),"\n",(0,i.jsx)(n.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"T"})]}),"\n",(0,i.jsx)(n.p,{children:"the GraphQL schema type to parse."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"processor?"})]}),"\n",(0,i.jsx)(n.p,{children:"optional callback function to parse the fields map."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"fallback?"}),": ",(0,i.jsx)(n.code,{children:"V"})]}),"\n",(0,i.jsxs)(n.p,{children:["optional fallback value, ",(0,i.jsx)(n.code,{children:"undefined"})," if not set."]}),"\n",(0,i.jsx)(n.h3,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"GraphQLObjectType"}),"<",(0,i.jsx)(n.code,{children:"any"}),", ",(0,i.jsx)(n.code,{children:"any"}),"> | ",(0,i.jsx)(n.code,{children:"GraphQLFieldMap"}),"<",(0,i.jsx)(n.code,{children:"unknown"}),", ",(0,i.jsx)(n.code,{children:"unknown"}),"> | ",(0,i.jsx)(n.code,{children:"GraphQLInputFieldMap"})," | ",(0,i.jsx)(n.code,{children:"V"})]}),"\n",(0,i.jsxs)(n.p,{children:["a map of fields as k/v records, or ",(0,i.jsx)(n.code,{children:"fallback"})," value if no fields available."]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/introspection.ts#L317",children:"packages/graphql/src/introspection.ts:317"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"getdirective",children:"getDirective()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function getDirective(entity, directives): GraphQLDirective[]\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-3",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"entity"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.p,{children:"a GraphQL schema entity."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"directives"}),": ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"GraphQLDirective"}),"[]>"]}),"\n",(0,i.jsx)(n.p,{children:"a directive name or a list of directive names."}),"\n",(0,i.jsx)(n.h3,{id:"returns-3",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"GraphQLDirective"}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["a list of GraphQL directives matching the set, else ",(0,i.jsx)(n.code,{children:"false"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/introspection.ts#L226",children:"packages/graphql/src/introspection.ts:226"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"getdirectivelocationforastpath",children:"getDirectiveLocationForASTPath()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function getDirectiveLocationForASTPath(appliedTo): DirectiveLocation\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-4",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"appliedTo"}),": ",(0,i.jsx)(n.code,{children:"any"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-4",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"DirectiveLocation"})}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-4",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/introspection.ts#L113",children:"packages/graphql/src/introspection.ts:113"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"getfields",children:"getFields()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function getFields(type): unknown[]\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-5",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.p,{children:"the GraphQL schema type to parse."}),"\n",(0,i.jsx)(n.h3,{id:"returns-5",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"unknown"}),"[]"]}),"\n",(0,i.jsx)(n.p,{children:"a list of fields of type object."}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-5",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/introspection.ts#L386",children:"packages/graphql/src/introspection.ts:386"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"getoperation",children:"getOperation()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function getOperation(operationType?): Record\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-6",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"operationType?"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.p,{children:"the operation type to parse."}),"\n",(0,i.jsx)(n.h3,{id:"returns-6",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Record"}),"<",(0,i.jsx)(n.code,{children:"string"}),", ",(0,i.jsx)(n.code,{children:"GraphQLOperationType"}),">"]}),"\n",(0,i.jsx)(n.p,{children:"a map of fields as k/v records."}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-6",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/introspection.ts#L362",children:"packages/graphql/src/introspection.ts:362"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"getschemamap",children:"getSchemaMap()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function getSchemaMap(schema): SchemaMap\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-7",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"schema"}),": ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"GraphQLSchema"}),">"]}),"\n",(0,i.jsx)(n.p,{children:"a GraphQL schema."}),"\n",(0,i.jsx)(n.h3,{id:"returns-7",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"SchemaMap"})}),"\n",(0,i.jsx)(n.p,{children:"a schema map by GraphQL entities (see SchemaEntity)."}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-7",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/introspection.ts#L496",children:"packages/graphql/src/introspection.ts:496"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"gettypedirectiveargvalue",children:"getTypeDirectiveArgValue()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function getTypeDirectiveArgValue(\n directive, \n node, \nargName): Maybe>\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-8",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"directive"}),": ",(0,i.jsx)(n.code,{children:"GraphQLDirective"})]}),"\n",(0,i.jsx)(n.p,{children:"a GraphQL directive defined in the schema."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"node"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"argName"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.p,{children:"the name of the GraphQL directive argument to fetch the value from."}),"\n",(0,i.jsx)(n.h3,{id:"returns-8",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"Record"}),"<",(0,i.jsx)(n.code,{children:"string"}),", ",(0,i.jsx)(n.code,{children:"unknown"}),">>"]}),"\n",(0,i.jsxs)(n.p,{children:["a record k/v with ",(0,i.jsx)(n.code,{children:"argName"})," as key and the argument's value."]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-8",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/introspection.ts#L289",children:"packages/graphql/src/introspection.ts:289"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"gettypedirectivevalues",children:"getTypeDirectiveValues()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function getTypeDirectiveValues(directive, type): Maybe>\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-9",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"directive"}),": ",(0,i.jsx)(n.code,{children:"GraphQLDirective"})]}),"\n",(0,i.jsx)(n.p,{children:"a GraphQL directive defined in the schema."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.p,{children:"the GraphQL schema type to parse."}),"\n",(0,i.jsx)(n.h3,{id:"returns-9",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"Record"}),"<",(0,i.jsx)(n.code,{children:"string"}),", ",(0,i.jsx)(n.code,{children:"unknown"}),">>"]}),"\n",(0,i.jsx)(n.p,{children:"a record k/v with arguments' name as keys and arguments' value."}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-9",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/introspection.ts#L258",children:"packages/graphql/src/introspection.ts:258"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"gettypefromschema",children:"getTypeFromSchema()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function getTypeFromSchema(schema, type): Maybe>\n"})}),"\n",(0,i.jsx)(n.h3,{id:"type-parameters-1",children:"Type Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"T"})]}),"\n",(0,i.jsx)(n.h3,{id:"parameters-10",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"schema"}),": ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"GraphQLSchema"}),">"]}),"\n",(0,i.jsx)(n.p,{children:"a GraphQL schema."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["a GraphQL type, eg ",(0,i.jsx)(n.code,{children:"GraphQLObjectType"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"returns-10",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"Record"}),"<",(0,i.jsx)(n.code,{children:"string"}),", ",(0,i.jsx)(n.code,{children:"T"}),">>"]}),"\n",(0,i.jsx)(n.p,{children:"a map of GraphQL named types for the matching GraphQL type, or undefined if no match."}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-10",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/introspection.ts#L61",children:"packages/graphql/src/introspection.ts:61"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"gettypename",children:"getTypeName()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function getTypeName(type, defaultName): string\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-11",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"defaultName"}),": ",(0,i.jsx)(n.code,{children:"string"})," = ",(0,i.jsx)(n.code,{children:'""'})]}),"\n",(0,i.jsx)(n.p,{children:"optional fallback value if the name resolution fails."}),"\n",(0,i.jsx)(n.h3,{id:"returns-11",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsxs)(n.p,{children:["the type's name, or ",(0,i.jsx)(n.code,{children:"defaultName"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-11",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/introspection.ts#L409",children:"packages/graphql/src/introspection.ts:409"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"hasastnode",children:"hasAstNode()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function hasAstNode(node): node is AstNodeType\n"})}),"\n",(0,i.jsx)(n.h3,{id:"type-parameters-2",children:"Type Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"T"})]}),"\n",(0,i.jsx)(n.h3,{id:"parameters-12",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"node"}),": ",(0,i.jsx)(n.code,{children:"T"})]}),"\n",(0,i.jsx)(n.p,{children:"a GraphQL schema named type."}),"\n",(0,i.jsx)(n.h3,{id:"returns-12",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"node is AstNodeType"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"true"})," if the entity has an AST node property, else ",(0,i.jsx)(n.code,{children:"false"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-12",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/introspection.ts#L109",children:"packages/graphql/src/introspection.ts:109"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"hasdirective",children:"hasDirective()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function hasDirective(\n entity, \n directives, \n fallback): boolean\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-13",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"entity"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.p,{children:"a GraphQL schema entity."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"directives"}),": ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"GraphQLDirective"}),"[]>"]}),"\n",(0,i.jsx)(n.p,{children:"a directive name or a list of directive names."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"fallback"}),": ",(0,i.jsx)(n.code,{children:"boolean"})," = ",(0,i.jsx)(n.code,{children:"false"})]}),"\n",(0,i.jsx)(n.p,{children:"default value if the entity type is not a valid location for directives."}),"\n",(0,i.jsx)(n.h3,{id:"returns-13",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"true"})," if the entity has at least one directive matching, else ",(0,i.jsx)(n.code,{children:"false"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-13",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/introspection.ts#L188",children:"packages/graphql/src/introspection.ts:188"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"isvaliddirectivelocation",children:"isValidDirectiveLocation()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function isValidDirectiveLocation(entity, directive): boolean\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-14",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"entity"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.p,{children:"a GraphQL schema entity."}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"directive"}),": ",(0,i.jsx)(n.code,{children:"GraphQLDirective"})]}),"\n",(0,i.jsx)(n.p,{children:"a directive name."}),"\n",(0,i.jsx)(n.h3,{id:"returns-14",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"true"})," if the entity is a valid directive location, else ",(0,i.jsx)(n.code,{children:"false"}),"."]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-14",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/introspection.ts#L167",children:"packages/graphql/src/introspection.ts:167"})})]})}function o(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>t,x:()=>a});var i=r(96540);const s={},d=i.createContext(s);function t(e){const n=i.useContext(d);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:t(e.components),i.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6ca537f5.75fb5db1.js b/assets/js/6ca537f5.75fb5db1.js new file mode 100644 index 000000000..5422811f5 --- /dev/null +++ b/assets/js/6ca537f5.75fb5db1.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[3169],{20079:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>p,frontMatter:()=>d,metadata:()=>l,toc:()=>o});var i=r(74848),t=r(28453);const d={title:"code",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},s=void 0,l={id:"printer-legacy/code",title:"code",description:"printCodeArguments()",source:"@site/api/printer-legacy/code.md",sourceDirName:"printer-legacy",slug:"/printer-legacy/code",permalink:"/api/printer-legacy/code",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"code",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},c={},o=[{value:"printCodeArguments()",id:"printcodearguments",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"printCodeField()",id:"printcodefield",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3}];function a(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"printcodearguments",children:"printCodeArguments()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printCodeArguments(type, indentationLevel): string\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"indentationLevel"}),": ",(0,i.jsx)(n.code,{children:"number"})," = ",(0,i.jsx)(n.code,{children:"1"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/code.ts#L16",children:"code.ts:16"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"printcodefield",children:"printCodeField()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printCodeField(\n type, \n options?, \n indentationLevel?): string | MDXString\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"indentationLevel?"}),": ",(0,i.jsx)(n.code,{children:"number"})," = ",(0,i.jsx)(n.code,{children:"0"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/code.ts#L50",children:"code.ts:50"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>l});var i=r(96540);const t={},d=i.createContext(t);function s(e){const n=i.useContext(d);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),i.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6e8812e8.1f5ce259.js b/assets/js/6e8812e8.1f5ce259.js new file mode 100644 index 000000000..1f29a6117 --- /dev/null +++ b/assets/js/6e8812e8.1f5ce259.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[2638],{36012:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>c,default:()=>h,frontMatter:()=>s,metadata:()=>d,toc:()=>a});var i=r(74848),t=r(28453);const s={id:"custom-directive",pagination_prev:null,pagination_next:null},c="Custom schema directives handling",d={id:"advanced/custom-directive",title:"Custom schema directives handling",description:"For directives applied to the schema, you can select which ones to be rendered for the types or in the locations they are declared. Information about the custom directives includes a custom description.",source:"@site/docs/advanced/custom-directive.md",sourceDirName:"advanced",slug:"/advanced/custom-directive",permalink:"/docs/advanced/custom-directive",draft:!1,unlisted:!1,editUrl:"https://github.com/graphql-markdown/graphql-markdown/tree/main/docs/advanced/custom-directive.md",tags:[],version:"current",frontMatter:{id:"custom-directive",pagination_prev:null,pagination_next:null},sidebar:"defaultSidebar"},o={},a=[{value:"Usage",id:"usage",level:2},{value:"descriptor",id:"descriptor",level:3},{value:"tag",id:"tag",level:3},{value:"Wildcard",id:"wildcard",level:3},{value:"Helpers",id:"helpers",level:2},{value:"@graphql-markdown/helpers",id:"graphql-markdownhelpers",level:3},{value:"@graphql-markdown/graphql",id:"graphql-markdowngraphql",level:3}];function l(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"custom-schema-directives-handling",children:"Custom schema directives handling"}),"\n",(0,i.jsx)(n.p,{children:"For directives applied to the schema, you can select which ones to be rendered for the types or in the locations they are declared. Information about the custom directives includes a custom description."}),"\n",(0,i.jsxs)(n.p,{children:["For example, we have one query called ",(0,i.jsx)(n.code,{children:"searchRole"}),", and we want to limit access to ",(0,i.jsx)(n.code,{children:"ADMIN"})," user roles only."]}),"\n",(0,i.jsxs)(n.p,{children:["We can accomplish this by adding a directive called ",(0,i.jsx)(n.code,{children:"auth"})," with an argument ",(0,i.jsx)(n.code,{children:"requires"})," to the query."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-graphql",children:"directive @auth(requires: Roles = ADMIN) on OBJECT | FIELD_DEFINITION\n\nenum Roles {\n ADMIN\n USER\n}\n\ntype Query {\n searchRole(roles: [Roles!]! = [ADMIN]): Int! @auth\n}\n"})}),"\n",(0,i.jsx)(n.h2,{id:"usage",children:"Usage"}),"\n",(0,i.jsxs)(n.p,{children:["Add the option ",(0,i.jsx)(n.a,{href:"/docs/settings#customdirective",children:(0,i.jsx)(n.code,{children:"customDirective"})})," to the ",(0,i.jsx)(n.code,{children:"@graphql-markdown/docusaurus"})," configuration."]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"descriptor"})," and ",(0,i.jsx)(n.code,{children:"tag"})," functions receive 2 arguments:"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"directive"})," of type ",(0,i.jsx)(n.a,{href:"https://github.com/graphql/graphql-js/blob/main/src/type/directives.ts",children:(0,i.jsx)(n.code,{children:"GraphQLDirective"})})]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.code,{children:"node"})," of type ",(0,i.jsx)(n.a,{href:"https://github.com/graphql/graphql-js/blob/main/src/type/definition.ts",children:(0,i.jsx)(n.code,{children:"GraphQLNamedType"})})," or ",(0,i.jsx)(n.a,{href:"https://github.com/graphql/graphql-js/blob/main/src/language/ast.ts",children:(0,i.jsx)(n.code,{children:"ASTNode"})})]}),"\n"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"type DirectiveName = string & { _opaque: typeof DirectiveName };\n\ntype CustomDirective = {\n [name: DirectiveName]: {\n descriptor?: (directive?: GraphQLDirective, node?: unknown): string;\n tag?: (directive?: GraphQLDirective, node?: unknown): Badge;\n };\n};\n\ntype Badge = {\n text: string | TypeLocale;\n classname: string;\n};\n"})}),"\n",(0,i.jsx)(n.h3,{id:"descriptor",children:(0,i.jsx)(n.code,{children:"descriptor"})}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"descriptor"})," allows rendering the custom directive's description applicable to entities."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",metastring:'title="docusaurus.config.js"',children:'plugins: [\n [\n "@graphql-markdown/docusaurus",\n /** @type {import(\'@graphql-markdown/types\').ConfigOptions} */\n {\n // ... other options\n customDirective: {\n auth: {\n // highlight-start\n descriptor: (directive, node) =>\n directiveDescriptor(\n directive,\n node,\n "This requires the current user to be in `${requires}` role.",\n ),\n // highlight-end\n }\n // ... other custom directive options\n },\n },\n ],\n],\n'})}),"\n",(0,i.jsx)(n.h3,{id:"tag",children:(0,i.jsx)(n.code,{children:"tag"})}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"tag"})," allows rendering custom badges (tags) based on the custom directive applicable to entities."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",metastring:'title="docusaurus.config.js"',children:'plugins: [\n [\n "@graphql-markdown/docusaurus",\n /** @type {import(\'@graphql-markdown/types\').ConfigOptions} */\n {\n // ... other options\n customDirective: {\n beta: {\n // highlight-next-line\n tag: (directive, node) => ({ text: directive.name, classname: "badge--info" }),\n }\n // ... other custom directive options\n },\n },\n ],\n],\n'})}),"\n",(0,i.jsx)(n.h3,{id:"wildcard",children:"Wildcard"}),"\n",(0,i.jsxs)(n.p,{children:["You can use ",(0,i.jsxs)(n.strong,{children:[(0,i.jsx)(n.code,{children:'"*"'})," as a wildcard"]})," for the directive name. This will allow all directives not declared with their name under ",(0,i.jsx)(n.code,{children:"customDirective"})," to be handled by the wildcard ",(0,i.jsx)(n.code,{children:"descriptor"})," and/or ",(0,i.jsx)(n.code,{children:"tag"}),"."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-js",metastring:'title="docusaurus.config.js"',children:'const { directiveDescriptor, tagDescriptor } = require("@graphql-markdown/helpers");\n\n//...//\n\nplugins: [\n [\n "@graphql-markdown/docusaurus",\n /** @type {import(\'@graphql-markdown/types\').ConfigOptions} */\n {\n // ... other options\n customDirective: {\n // highlight-start\n "*": {\n descriptor: directiveDescriptor,\n tag: tagDescriptor,\n },\n // highlight-end\n // ... optionally specific custom directive options\n },\n },\n ],\n],\n'})}),"\n",(0,i.jsx)(n.h2,{id:"helpers",children:"Helpers"}),"\n",(0,i.jsxs)(n.p,{children:["The packages ",(0,i.jsx)(n.code,{children:"@graphql-markdown/helpers"})," and ",(0,i.jsx)(n.code,{children:"@graphql-markdown/graphql"})," provide a few helper functions to quickly start."]}),"\n",(0,i.jsxs)(n.admonition,{type:"info",children:[(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"@graphql-markdown/helpers"})," is an optional peer dependency, and it needs to be installed before using it."]}),(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-shell",metastring:'title="shell"',children:"npm i @graphql-markdown/helpers\n"})})]}),"\n",(0,i.jsx)(n.h3,{id:"graphql-markdownhelpers",children:(0,i.jsx)(n.code,{children:"@graphql-markdown/helpers"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/api/helpers/directives/descriptor",children:(0,i.jsx)(n.code,{children:"directiveDescriptor"})})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/api/helpers/directives/tag",children:(0,i.jsx)(n.code,{children:"tagDescriptor"})})}),"\n"]}),"\n",(0,i.jsx)(n.h3,{id:"graphql-markdowngraphql",children:(0,i.jsx)(n.code,{children:"@graphql-markdown/graphql"})}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/api/graphql/introspection#gettypedirectivevalues",children:(0,i.jsx)(n.code,{children:"getTypeDirectiveValues"})})}),"\n",(0,i.jsx)(n.li,{children:(0,i.jsx)(n.a,{href:"/api/graphql/introspection#gettypedirectiveargvalue",children:(0,i.jsx)(n.code,{children:"getTypeDirectiveArgValue"})})}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>d});var i=r(96540);const t={},s=i.createContext(t);function c(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/7c7d3934.4e5d7aea.js b/assets/js/7c7d3934.4e5d7aea.js new file mode 100644 index 000000000..cb4a33e43 --- /dev/null +++ b/assets/js/7c7d3934.4e5d7aea.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[8009],{51287:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>a});var i=r(74848),s=r(28453);const t={title:"common",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},c=void 0,d={id:"printer-legacy/common",title:"common",description:"formatDescription()",source:"@site/api/printer-legacy/common.md",sourceDirName:"printer-legacy",slug:"/printer-legacy/common",permalink:"/api/printer-legacy/common",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"common",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},l={},a=[{value:"formatDescription()",id:"formatdescription",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"hasPrintableDirective()",id:"hasprintabledirective",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3},{value:"printCustomDirectives()",id:"printcustomdirectives",level:2},{value:"Parameters",id:"parameters-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Defined in",id:"defined-in-2",level:3},{value:"printDeprecation()",id:"printdeprecation",level:2},{value:"Parameters",id:"parameters-3",level:3},{value:"Returns",id:"returns-3",level:3},{value:"Defined in",id:"defined-in-3",level:3},{value:"printDescription()",id:"printdescription",level:2},{value:"Parameters",id:"parameters-4",level:3},{value:"Returns",id:"returns-4",level:3},{value:"Defined in",id:"defined-in-4",level:3},{value:"printWarning()",id:"printwarning",level:2},{value:"Parameters",id:"parameters-5",level:3},{value:"Returns",id:"returns-5",level:3},{value:"Defined in",id:"defined-in-5",level:3}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"formatdescription",children:"formatDescription()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function formatDescription(type, replacement): string | MDXString\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"replacement"}),": ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"string"}),"> = ",(0,i.jsx)(n.code,{children:"NO_DESCRIPTION_TEXT"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/common.ts#L54",children:"common.ts:54"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"hasprintabledirective",children:"hasPrintableDirective()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function hasPrintableDirective(type, options?): boolean\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"Pick"}),"<",(0,i.jsx)(n.code,{children:"PrintTypeOptions"}),", ",(0,i.jsx)(n.code,{children:'"deprecated"'})," | ",(0,i.jsx)(n.code,{children:'"onlyDocDirectives"'})," | ",(0,i.jsx)(n.code,{children:'"skipDocDirectives"'}),">"]}),"\n",(0,i.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"boolean"})}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/common.ts#L105",children:"common.ts:105"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"printcustomdirectives",children:"printCustomDirectives()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printCustomDirectives(type, options?): string\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/common.ts#L21",children:"common.ts:21"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"printdeprecation",children:"printDeprecation()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printDeprecation(type): string\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-3",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-3",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/common.ts#L81",children:"common.ts:81"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"printdescription",children:"printDescription()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printDescription(\n type, \n options?, \n noText?): string | MDXString\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-4",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"noText?"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-4",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-4",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/common.ts#L94",children:"common.ts:94"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"printwarning",children:"printWarning()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printWarning(text?, title?): string\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-5",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"text?"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"title?"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-5",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-5",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/common.ts#L69",children:"common.ts:69"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>c,x:()=>d});var i=r(96540);const s={},t=i.createContext(s);function c(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/847a047e.315ac7a2.js b/assets/js/847a047e.315ac7a2.js new file mode 100644 index 000000000..2b6d3da3c --- /dev/null +++ b/assets/js/847a047e.315ac7a2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[2843],{93398:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>t,default:()=>p,frontMatter:()=>r,metadata:()=>a,toc:()=>d});var l=i(74848),s=i(28453);const r={title:"options",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},t=void 0,a={id:"printer-legacy/const/options",title:"options",description:"SectionLevels",source:"@site/api/printer-legacy/const/options.md",sourceDirName:"printer-legacy/const",slug:"/printer-legacy/const/options",permalink:"/api/printer-legacy/const/options",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"options",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},c={},d=[{value:"SectionLevels",id:"sectionlevels",level:2},{value:"Enumeration Members",id:"enumeration-members",level:3},{value:"LEVEL_3",id:"level_3",level:4},{value:"Defined in",id:"defined-in",level:5},{value:"LEVEL_4",id:"level_4",level:4},{value:"Defined in",id:"defined-in-1",level:5},{value:"LEVEL_5",id:"level_5",level:4},{value:"Defined in",id:"defined-in-2",level:5},{value:"NONE",id:"none",level:4},{value:"Defined in",id:"defined-in-3",level:5},{value:"DEFAULT_OPTIONS",id:"default_options",level:2},{value:"Type declaration",id:"type-declaration",level:3},{value:"collapsible",id:"collapsible",level:4},{value:"groups",id:"groups",level:4},{value:"level",id:"level",level:4},{value:"onlyDocDirectives",id:"onlydocdirectives",level:4},{value:"parentType",id:"parenttype",level:4},{value:"schema",id:"schema",level:4},{value:"skipDocDirectives",id:"skipdocdirectives",level:4},{value:"Defined in",id:"defined-in-4",level:3},{value:"PRINT_TYPE_DEFAULT_OPTIONS",id:"print_type_default_options",level:2},{value:"Defined in",id:"defined-in-5",level:3}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.h2,{id:"sectionlevels",children:"SectionLevels"}),"\n",(0,l.jsx)(n.h3,{id:"enumeration-members",children:"Enumeration Members"}),"\n",(0,l.jsx)(n.h4,{id:"level_3",children:"LEVEL_3"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:'LEVEL_3: "###";\n'})}),"\n",(0,l.jsx)(n.h5,{id:"defined-in",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/const/options.ts#L15",children:"const/options.ts:15"})}),"\n",(0,l.jsx)(n.h4,{id:"level_4",children:"LEVEL_4"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:'LEVEL_4: "####";\n'})}),"\n",(0,l.jsx)(n.h5,{id:"defined-in-1",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/const/options.ts#L16",children:"const/options.ts:16"})}),"\n",(0,l.jsx)(n.h4,{id:"level_5",children:"LEVEL_5"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:'LEVEL_5: "#####";\n'})}),"\n",(0,l.jsx)(n.h5,{id:"defined-in-2",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/const/options.ts#L17",children:"const/options.ts:17"})}),"\n",(0,l.jsx)(n.h4,{id:"none",children:"NONE"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:'NONE: "";\n'})}),"\n",(0,l.jsx)(n.h5,{id:"defined-in-3",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/const/options.ts#L14",children:"const/options.ts:14"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h2,{id:"default_options",children:"DEFAULT_OPTIONS"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:'const DEFAULT_OPTIONS: Required> & object;\n'})}),"\n",(0,l.jsx)(n.h3,{id:"type-declaration",children:"Type declaration"}),"\n",(0,l.jsx)(n.h4,{id:"collapsible",children:"collapsible"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"collapsible: Maybe;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"groups",children:"groups"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"groups: Maybe;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"level",children:"level"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"level: Maybe;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"onlydocdirectives",children:"onlyDocDirectives"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"onlyDocDirectives: GraphQLDirective[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parenttype",children:"parentType"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"parentType: Maybe;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"schema",children:"schema"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"schema: Maybe;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"skipdocdirectives",children:"skipDocDirectives"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"skipDocDirectives: GraphQLDirective[];\n"})}),"\n",(0,l.jsx)(n.h3,{id:"defined-in-4",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/const/options.ts#L32",children:"const/options.ts:32"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h2,{id:"print_type_default_options",children:"PRINT_TYPE_DEFAULT_OPTIONS"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"const PRINT_TYPE_DEFAULT_OPTIONS: Required;\n"})}),"\n",(0,l.jsx)(n.h3,{id:"defined-in-5",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/const/options.ts#L20",children:"const/options.ts:20"})})]})}function p(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(o,{...e})}):o(e)}},28453:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>a});var l=i(96540);const s={},r=l.createContext(s);function t(e){const n=l.useContext(r);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:t(e.components),l.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/881202c4.5b4d600d.js b/assets/js/881202c4.5b4d600d.js new file mode 100644 index 000000000..0939fb2d6 --- /dev/null +++ b/assets/js/881202c4.5b4d600d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[414],{97101:(e,n,a)=>{a.r(n),a.d(n,{assets:()=>i,contentTitle:()=>l,default:()=>h,frontMatter:()=>r,metadata:()=>t,toc:()=>c});var o=a(74848),s=a(28453);const r={pagination_prev:null,pagination_next:null},l="Schema loading",t={id:"advanced/schema-loading",title:"Schema loading",description:"GraphQL-Markdown use external loaders for loading GraphQL schemas (see full list).",source:"@site/docs/advanced/schema-loading.md",sourceDirName:"advanced",slug:"/advanced/schema-loading",permalink:"/docs/advanced/schema-loading",draft:!1,unlisted:!1,editUrl:"https://github.com/graphql-markdown/graphql-markdown/tree/main/docs/advanced/schema-loading.md",tags:[],version:"current",frontMatter:{pagination_prev:null,pagination_next:null},sidebar:"defaultSidebar"},i={},c=[{value:"Local schema (file)",id:"local-schema-file",level:2},{value:"Remote schema (url)",id:"remote-schema-url",level:2}];function d(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"schema-loading",children:"Schema loading"}),"\n",(0,o.jsxs)(n.p,{children:["GraphQL-Markdown use external loaders for loading GraphQL schemas (see ",(0,o.jsx)(n.a,{href:"https://github.com/ardatan/graphql-tools/tree/master/packages/loaders",children:"full list"}),")."]}),"\n",(0,o.jsxs)(n.p,{children:["You can declare as many loaders as you need using a ",(0,o.jsx)(n.code,{children:"LoaderOption"})," map:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-ts",children:"// highlight-start\ntype LoaderOption = {\n [name: ClassName]: PackageName | PackageConfig;\n};\n// highlight-end\n\ntype PackageName = string & { _opaque: typeof PackageName };\n\ntype ClassName = string & { _opaque: typeof ClassName };\n\ntype PackageConfig = {\n module: PackageName;\n options?: PackageOptionsConfig;\n};\n\ntype RootTypes = { query?: string; mutation?: string; subscription?: string };\n\ntype PackageOptionsConfig = BaseLoaderOptions & RootTypes;\n"})}),"\n",(0,o.jsx)(n.h2,{id:"local-schema-file",children:"Local schema (file)"}),"\n",(0,o.jsxs)(n.p,{children:["Use ",(0,o.jsx)(n.code,{children:"@graphql-tools/graphql-file-loader"})," if you want to load a local schema:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-shell",metastring:'title="shell"',children:"npm install @graphql-tools/graphql-file-loader\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Once done, you can declare the loader in ",(0,o.jsx)(n.code,{children:"@graphql-markdown/docusaurus"})," configuration:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-js",metastring:'title="docusaurus.config.js"',children:'plugins: [\n [\n "@graphql-markdown/docusaurus",\n /** @type {import(\'@graphql-markdown/types\').ConfigOptions} */\n {\n // ... other options\n loaders: {\n GraphQLFileLoader: "@graphql-tools/graphql-file-loader"\n }\n },\n ],\n],\n'})}),"\n",(0,o.jsx)(n.h2,{id:"remote-schema-url",children:"Remote schema (url)"}),"\n",(0,o.jsxs)(n.p,{children:["Use ",(0,o.jsx)(n.code,{children:"@graphql-tools/url-loader"}),", if you want to load a schema from a URL:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-shell",metastring:'title="shell"',children:"npm install @graphql-tools/url-loader\n"})}),"\n",(0,o.jsxs)(n.p,{children:["Once done, you can declare the loader in ",(0,o.jsx)(n.code,{children:"@graphql-markdown/docusaurus"})," configuration:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-js",metastring:'title="docusaurus.config.js"',children:'plugins: [\n [\n "@graphql-markdown/docusaurus",\n /** @type {import(\'@graphql-markdown/types\').ConfigOptions} */\n {\n // ... other options\n loaders: {\n UrlLoader: {\n module: "@graphql-tools/url-loader",\n options: {\n headers: {\n Authorization: "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"\n }\n }\n }\n }\n },\n ],\n],\n'})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(d,{...e})}):d(e)}},28453:(e,n,a)=>{a.d(n,{R:()=>l,x:()=>t});var o=a(96540);const s={},r=o.createContext(s);function l(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/89554646.a9762ba0.js b/assets/js/89554646.a9762ba0.js new file mode 100644 index 000000000..1d336bd91 --- /dev/null +++ b/assets/js/89554646.a9762ba0.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[784],{77619:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>c,contentTitle:()=>d,default:()=>p,frontMatter:()=>a,metadata:()=>s,toc:()=>l});var i=n(74848),t=n(28453);const a={title:"directive",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},d=void 0,s={id:"printer-legacy/graphql/directive",title:"directive",description:"printCodeDirective()",source:"@site/api/printer-legacy/graphql/directive.md",sourceDirName:"printer-legacy/graphql",slug:"/printer-legacy/graphql/directive",permalink:"/api/printer-legacy/graphql/directive",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"directive",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},c={},l=[{value:"printCodeDirective()",id:"printcodedirective",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"printDirectiveMetadata()",id:"printdirectivemetadata",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3}];function o(e){const r={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(r.h2,{id:"printcodedirective",children:"printCodeDirective()"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"function printCodeDirective(type, options?): string\n"})}),"\n",(0,i.jsx)(r.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"type"}),": ",(0,i.jsx)(r.code,{children:"GraphQLDirective"})]}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"options?"}),": ",(0,i.jsx)(r.code,{children:"PrintDirectiveOptions"})]}),"\n",(0,i.jsx)(r.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.code,{children:"string"})}),"\n",(0,i.jsx)(r.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/graphql/directive.ts#L38",children:"graphql/directive.ts:38"})}),"\n",(0,i.jsx)(r.hr,{}),"\n",(0,i.jsx)(r.h2,{id:"printdirectivemetadata",children:"printDirectiveMetadata()"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"function printDirectiveMetadata(type, options): string | MDXString\n"})}),"\n",(0,i.jsx)(r.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"type"}),": ",(0,i.jsx)(r.code,{children:"GraphQLDirective"})]}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"options"}),": ",(0,i.jsx)(r.code,{children:"PrintDirectiveOptions"})]}),"\n",(0,i.jsx)(r.h3,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.code,{children:"string"})," | ",(0,i.jsx)(r.code,{children:"MDXString"})]}),"\n",(0,i.jsx)(r.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/graphql/directive.ts#L27",children:"graphql/directive.ts:27"})})]})}function p(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},28453:(e,r,n)=>{n.d(r,{R:()=>d,x:()=>s});var i=n(96540);const t={},a=i.createContext(t);function d(e){const r=i.useContext(a);return i.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function s(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:d(e.components),i.createElement(a.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8cd5ecab.df083543.js b/assets/js/8cd5ecab.df083543.js new file mode 100644 index 000000000..a288b350b --- /dev/null +++ b/assets/js/8cd5ecab.df083543.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[4136],{2016:(e,n,s)=>{s.r(n),s.d(n,{Badge:()=>m,Bullet:()=>d,Details:()=>h,SpecifiedBy:()=>p,assets:()=>l,contentTitle:()=>i,default:()=>x,frontMatter:()=>o,metadata:()=>c,toc:()=>u});var t=s(74848),r=s(28453),a=s(96540);const o={id:"skip",title:"skip"},i=void 0,c={id:"common/directives/skip",title:"skip",description:"Directs the executor to skip this field or fragment when the if argument is true.",source:"@site/examples/group-by/common/directives/skip.mdx",sourceDirName:"common/directives",slug:"/common/directives/skip",permalink:"/examples/group-by/common/directives/skip",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{id:"skip",title:"skip"},sidebar:"schemaSidebar",previous:{title:"oneOf",permalink:"/examples/group-by/common/directives/one-of"},next:{title:"specifiedBy",permalink:"/examples/group-by/common/directives/specified-by"}},l={},d=()=>{const e={span:"span",...(0,r.R)()};return(0,t.jsx)(t.Fragment,{children:(0,t.jsx)(e.span,{style:{fontWeight:"normal",fontSize:".5em",color:"var(--ifm-color-secondary-darkest)"},children:"\xa0\u25cf\xa0"})})},p=e=>{const n={a:"a",...(0,r.R)()};return(0,t.jsxs)(t.Fragment,{children:["Specification",(0,t.jsx)(n.a,{className:"link",style:{fontSize:"1.5em",paddingLeft:"4px"},target:"_blank",href:e.url,title:"Specified by "+e.url,children:"\u2398"})]})},m=e=>{const n={span:"span",...(0,r.R)()};return(0,t.jsx)(t.Fragment,{children:(0,t.jsx)(n.span,{className:e.class,children:e.text})})},u=[{value:"Arguments",id:"arguments",level:3},{value:'ifBoolean! ',id:"ifboolean---",level:4}],h=({dataOpen:e,dataClose:n,children:s,startOpen:o=!1})=>{const i={details:"details",summary:"summary",...(0,r.R)()},[c,l]=(0,a.useState)(o);return(0,t.jsxs)(i.details,{...c?{open:!0}:{},className:"details",style:{border:"none",boxShadow:"none",background:"var(--ifm-background-color)"},children:[(0,t.jsx)(i.summary,{onClick:e=>{e.preventDefault(),l((e=>!e))},style:{listStyle:"none"},children:c?e:n}),c&&s]})};function g(e){const n={a:"a",blockquote:"blockquote",code:"code",h3:"h3",h4:"h4",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsxs)(n.p,{children:["Directs the executor to skip this field or fragment when the ",(0,t.jsx)(n.code,{children:"if"})," argument is true."]}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-graphql",children:"directive @skip(\n if: Boolean!\n) on \r\n | FIELD\r\n | FRAGMENT_SPREAD\r\n | INLINE_FRAGMENT\n"})}),"\n",(0,t.jsx)(n.h3,{id:"arguments",children:"Arguments"}),"\n",(0,t.jsxs)(n.h4,{id:"ifboolean---",children:[(0,t.jsx)(n.a,{href:"#",children:(0,t.jsx)(n.code,{children:"if"})}),(0,t.jsx)(d,{}),(0,t.jsx)(n.a,{href:"/examples/group-by/common/scalars/boolean",children:(0,t.jsx)(n.code,{children:"Boolean!"})})," ",(0,t.jsx)(m,{class:"badge badge--secondary",text:"non-null"})," ",(0,t.jsx)(m,{class:"badge badge--secondary",text:"scalar"})," ",(0,t.jsx)(m,{class:"badge badge--secondary",text:"common"})]}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsx)(n.p,{children:"Skipped when true."}),"\n"]})]})}function x(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(g,{...e})}):g(e)}},28453:(e,n,s)=>{s.d(n,{R:()=>o,x:()=>i});var t=s(96540);const r={},a=t.createContext(r);function o(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/8d936e6f.2034f4cd.js b/assets/js/8d936e6f.2034f4cd.js new file mode 100644 index 000000000..6de183a08 --- /dev/null +++ b/assets/js/8d936e6f.2034f4cd.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[7916],{66097:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>h,frontMatter:()=>s,metadata:()=>d,toc:()=>t});var i=r(74848),o=r(28453);const s={title:"graphql-config",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},a=void 0,d={id:"core/graphql-config",title:"graphql-config",description:"EXTENSION\\_NAME",source:"@site/api/core/graphql-config.md",sourceDirName:"core",slug:"/core/graphql-config",permalink:"/api/core/graphql-config",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"graphql-config",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},l={},t=[{value:"EXTENSION_NAME",id:"extension_name",level:2},{value:"Defined in",id:"defined-in",level:3},{value:"graphQLConfigExtension",id:"graphqlconfigextension",level:2},{value:"Defined in",id:"defined-in-1",level:3},{value:"loadConfiguration()",id:"loadconfiguration",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in-2",level:3},{value:"setLoaderOptions()",id:"setloaderoptions",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-3",level:3}];function c(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"extension_name",children:"EXTENSION_NAME"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:'const EXTENSION_NAME: "graphql-markdown";\n'})}),"\n",(0,i.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/graphql-config.ts#L13",children:"graphql-config.ts:13"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"graphqlconfigextension",children:"graphQLConfigExtension"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"const graphQLConfigExtension: GraphQLExtensionDeclaration;\n"})}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/graphql-config.ts#L14",children:"graphql-config.ts:14"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"loadconfiguration",children:"loadConfiguration()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function loadConfiguration(\n id, \n options?, \n__namedParameters?): Promise>>\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"id"}),": ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options?"}),": ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"PackageOptionsConfig"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"__namedParameters?"}),": ",(0,i.jsx)(n.code,{children:"ThrowOptions"})," = ",(0,i.jsx)(n.code,{children:"..."})]}),"\n",(0,i.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"Readonly"}),"<",(0,i.jsx)(n.code,{children:"ExtensionProjectConfig"}),">>>"]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/graphql-config.ts#L43",children:"graphql-config.ts:43"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"setloaderoptions",children:"setLoaderOptions()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function setLoaderOptions(loaders, options): LoaderOption\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"loaders"}),": ",(0,i.jsx)(n.code,{children:"LoaderOption"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PackageOptionsConfig"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"LoaderOption"})}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/graphql-config.ts#L23",children:"graphql-config.ts:23"})})]})}function h(e={}){const{wrapper:n}={...(0,o.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>a,x:()=>d});var i=r(96540);const o={},s=i.createContext(o);function a(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:a(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/92c78daf.cb62e0a7.js b/assets/js/92c78daf.cb62e0a7.js new file mode 100644 index 000000000..a37ce61f7 --- /dev/null +++ b/assets/js/92c78daf.cb62e0a7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[8101],{33415:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>o,contentTitle:()=>s,default:()=>p,frontMatter:()=>l,metadata:()=>i,toc:()=>d});var n=r(74848),a=r(28453);const l={title:"formatter",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},s=void 0,i={id:"graphql/formatter",title:"formatter",description:"Internal library of helpers for formatting GraphQL values.",source:"@site/api/graphql/formatter.md",sourceDirName:"graphql",slug:"/graphql/formatter",permalink:"/api/graphql/formatter",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"formatter",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},o={},d=[{value:"getFormattedDefaultValue()",id:"getformatteddefaultvalue",level:2},{value:"Type Parameters",id:"type-parameters",level:3},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3}];function c(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.p,{children:"Internal library of helpers for formatting GraphQL values."}),"\n",(0,n.jsx)(t.h2,{id:"getformatteddefaultvalue",children:"getFormattedDefaultValue()"}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ts",children:"function getFormattedDefaultValue(entity): Maybe\n"})}),"\n",(0,n.jsx)(t.h3,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,n.jsxs)(t.p,{children:["\u2022 ",(0,n.jsx)(t.strong,{children:"T"})]}),"\n",(0,n.jsx)(t.h3,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(t.p,{children:["\u2022 ",(0,n.jsx)(t.strong,{children:"entity"})]}),"\n",(0,n.jsx)(t.p,{children:"the GraphQL schema entity processed."}),"\n",(0,n.jsxs)(t.p,{children:["\u2022 ",(0,n.jsx)(t.strong,{children:"entity.defaultValue"}),": ",(0,n.jsx)(t.code,{children:"T"})]}),"\n",(0,n.jsx)(t.p,{children:"the GraphQL schema type's value to be formatted."}),"\n",(0,n.jsxs)(t.p,{children:["\u2022 ",(0,n.jsx)(t.strong,{children:"entity.type"}),": ",(0,n.jsx)(t.code,{children:"Maybe"}),"<",(0,n.jsx)(t.code,{children:"GraphQLType"}),">"]}),"\n",(0,n.jsx)(t.p,{children:"the GraphQL schema type."}),"\n",(0,n.jsx)(t.h3,{id:"returns",children:"Returns"}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.code,{children:"Maybe"}),"<",(0,n.jsx)(t.code,{children:"string"})," | ",(0,n.jsx)(t.code,{children:"T"}),">"]}),"\n",(0,n.jsx)(t.p,{children:"a printable formatted value."}),"\n",(0,n.jsx)(t.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/formatter.ts#L94",children:"packages/graphql/src/formatter.ts:94"})})]})}function p(e={}){const{wrapper:t}={...(0,a.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(c,{...e})}):c(e)}},28453:(e,t,r)=>{r.d(t,{R:()=>s,x:()=>i});var n=r(96540);const a={},l=n.createContext(a);function s(e){const t=n.useContext(l);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:s(e.components),n.createElement(l.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/988d23d8.d5940aae.js b/assets/js/988d23d8.d5940aae.js new file mode 100644 index 000000000..ee17b4b2d --- /dev/null +++ b/assets/js/988d23d8.d5940aae.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[6657],{30598:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>d,contentTitle:()=>a,default:()=>p,frontMatter:()=>t,metadata:()=>c,toc:()=>o});var i=n(74848),s=n(28453);const t={title:"group",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},a=void 0,c={id:"graphql/group",title:"group",description:"Library supporting groupByDirective for grouping GraphQL schema entities.",source:"@site/api/graphql/group.md",sourceDirName:"graphql",slug:"/graphql/group",permalink:"/api/graphql/group",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"group",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},d={},o=[{value:"See",id:"see",level:2},{value:"getGroupName()",id:"getgroupname",level:2},{value:"Type Parameters",id:"type-parameters",level:3},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"getGroups()",id:"getgroups",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3}];function l(e){const r={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(r.p,{children:["Library supporting ",(0,i.jsx)(r.code,{children:"groupByDirective"})," for grouping GraphQL schema entities."]}),"\n",(0,i.jsx)(r.h2,{id:"see",children:"See"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsxs)(r.a,{href:"https://graphql-markdown.dev/docs/advanced/group-by-directive",children:["Option ",(0,i.jsx)(r.code,{children:"groupByDirective"})]})}),"\n",(0,i.jsx)(r.h2,{id:"getgroupname",children:"getGroupName()"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"function getGroupName(type, groupByDirective): Maybe\n"})}),"\n",(0,i.jsx)(r.h3,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"T"})]}),"\n",(0,i.jsx)(r.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"type"}),": ",(0,i.jsx)(r.code,{children:"T"})]}),"\n",(0,i.jsx)(r.p,{children:"a GraphQL schema named type"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"groupByDirective"}),": ",(0,i.jsx)(r.code,{children:"Maybe"}),"<",(0,i.jsx)(r.code,{children:"GroupByDirectiveOptions"}),">"]}),"\n",(0,i.jsxs)(r.p,{children:["the ",(0,i.jsx)(r.code,{children:"groupByDirective"})," option."]}),"\n",(0,i.jsx)(r.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.code,{children:"Maybe"}),"<",(0,i.jsx)(r.code,{children:"string"}),">"]}),"\n",(0,i.jsxs)(r.p,{children:["the group name matching the type, or ",(0,i.jsx)(r.code,{children:"groupByDirective.fallback"})," if no match found."]}),"\n",(0,i.jsx)(r.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/group.ts#L72",children:"packages/graphql/src/group.ts:72"})}),"\n",(0,i.jsx)(r.hr,{}),"\n",(0,i.jsx)(r.h2,{id:"getgroups",children:"getGroups()"}),"\n",(0,i.jsx)(r.pre,{children:(0,i.jsx)(r.code,{className:"language-ts",children:"function getGroups(schemaMap, groupByDirective): Maybe>>>>\n"})}),"\n",(0,i.jsx)(r.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"schemaMap"}),": ",(0,i.jsx)(r.code,{children:"SchemaMap"})]}),"\n",(0,i.jsxs)(r.p,{children:["the GraphQL schema map returned by ",(0,i.jsx)(r.a,{href:"/api/graphql/introspection#getschemamap",children:"introspection!getSchemaMap"})]}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"groupByDirective"}),": ",(0,i.jsx)(r.code,{children:"Maybe"}),"<",(0,i.jsx)(r.code,{children:"GroupByDirectiveOptions"}),">"]}),"\n",(0,i.jsxs)(r.p,{children:["the ",(0,i.jsx)(r.code,{children:"groupByDirective"})," option."]}),"\n",(0,i.jsx)(r.h3,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(r.p,{children:[(0,i.jsx)(r.code,{children:"Maybe"}),"<",(0,i.jsx)(r.code,{children:"Partial"}),"<",(0,i.jsx)(r.code,{children:"Record"}),"<",(0,i.jsx)(r.code,{children:"SchemaEntity"}),", ",(0,i.jsx)(r.code,{children:"Record"}),"<",(0,i.jsx)(r.code,{children:"string"}),", ",(0,i.jsx)(r.code,{children:"Maybe"}),"<",(0,i.jsx)(r.code,{children:"string"}),">>>>>"]}),"\n",(0,i.jsx)(r.p,{children:"a map of entities with matching group name."}),"\n",(0,i.jsx)(r.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/group.ts#L173",children:"packages/graphql/src/group.ts:173"})})]})}function p(e={}){const{wrapper:r}={...(0,s.R)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},28453:(e,r,n)=>{n.d(r,{R:()=>a,x:()=>c});var i=n(96540);const s={},t=i.createContext(s);function a(e){const r=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),i.createElement(t.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9d9f8394.4a57b8d9.js b/assets/js/9d9f8394.4a57b8d9.js new file mode 100644 index 000000000..a0ed5de18 --- /dev/null +++ b/assets/js/9d9f8394.4a57b8d9.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[9013],{87726:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>l,contentTitle:()=>s,default:()=>h,frontMatter:()=>a,metadata:()=>r,toc:()=>d});var o=t(74848),i=t(28453);const a={position:9,pagination_prev:null,pagination_next:null},s="Troubleshooting",r={id:"troubleshooting",title:"Troubleshooting",description:'Duplicate "graphql" modules cannot be used at the same time',source:"@site/docs/troubleshooting.md",sourceDirName:".",slug:"/troubleshooting",permalink:"/docs/troubleshooting",draft:!1,unlisted:!1,editUrl:"https://github.com/graphql-markdown/graphql-markdown/tree/main/docs/troubleshooting.md",tags:[],version:"current",frontMatter:{position:9,pagination_prev:null,pagination_next:null},sidebar:"defaultSidebar"},l={},d=[{value:"Duplicate "graphql" modules cannot be used at the same time",id:"duplicate-graphql-modules-cannot-be-used-at-the-same-time",level:2},{value:"Unable to find any GraphQL type definitions",id:"unable-to-find-any-graphql-type-definitions",level:2},{value:"Unable to find any GraphQL type definitions for the following pointers",id:"unable-to-find-any-graphql-type-definitions-for-the-following-pointers",level:2}];function c(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(n.h1,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,o.jsx)(n.h2,{id:"duplicate-graphql-modules-cannot-be-used-at-the-same-time",children:'Duplicate "graphql" modules cannot be used at the same time'}),"\n",(0,o.jsxs)(n.p,{children:["Add a ",(0,o.jsx)(n.code,{children:"resolutions"})," entry to your ",(0,o.jsx)(n.code,{children:"package.json"})," file:"]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-json",metastring:'title="package.json"',children:'"resolutions": {\n "graphql": "16.9.0"\n}\n'})}),"\n",(0,o.jsx)(n.h2,{id:"unable-to-find-any-graphql-type-definitions",children:"Unable to find any GraphQL type definitions"}),"\n",(0,o.jsxs)(n.p,{children:["Try changing the temporary folder for the plugin by setting ",(0,o.jsx)(n.code,{children:'tmpDir: "./.docusaurus"'})," (see ",(0,o.jsx)(n.a,{href:"/docs/settings",children:"settings"})," for more details)."]}),"\n",(0,o.jsxs)(n.p,{children:["You can also disable the schema diff feature with ",(0,o.jsx)(n.code,{children:'diffMethod: "NONE"'}),"."]}),"\n",(0,o.jsx)(n.h2,{id:"unable-to-find-any-graphql-type-definitions-for-the-following-pointers",children:"Unable to find any GraphQL type definitions for the following pointers"}),"\n",(0,o.jsxs)(n.p,{children:["Install and declare the missing GraphQL document loader package, see ",(0,o.jsx)(n.a,{href:"/docs/advanced/schema-loading",children:"schema loading"}),"."]}),"\n",(0,o.jsx)(n.p,{children:"If the error persists, check that you have the correct class name in the configuration declaration."})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(c,{...e})}):c(e)}},28453:(e,n,t)=>{t.d(n,{R:()=>s,x:()=>r});var o=t(96540);const i={},a=o.createContext(i);function s(e){const n=o.useContext(a);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),o.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/9de9df72.0c2d7c9c.js b/assets/js/9de9df72.0c2d7c9c.js new file mode 100644 index 000000000..949f0b5b8 --- /dev/null +++ b/assets/js/9de9df72.0c2d7c9c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[2747],{71434:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>d,contentTitle:()=>i,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>r});var s=t(74848),a=t(28453);const o={pagination_prev:null,pagination_next:null},i="Docs multi-instance",c={id:"advanced/docs-multi-instance",title:"Docs multi-instance",description:"In this use case, you have multiple sets of documentation (a.k.a. Docs Multi-instance), then you need to add a reference to sidebar-schema.js into the dedicated instance of @docusaurus/plugin-content-docs:",source:"@site/docs/advanced/docs-multi-instance.md",sourceDirName:"advanced",slug:"/advanced/docs-multi-instance",permalink:"/docs/advanced/docs-multi-instance",draft:!1,unlisted:!1,editUrl:"https://github.com/graphql-markdown/graphql-markdown/tree/main/docs/advanced/docs-multi-instance.md",tags:[],version:"current",frontMatter:{pagination_prev:null,pagination_next:null},sidebar:"defaultSidebar"},d={},r=[];function u(n){const e={a:"a",code:"code",h1:"h1",p:"p",pre:"pre",...(0,a.R)(),...n.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(e.h1,{id:"docs-multi-instance",children:"Docs multi-instance"}),"\n",(0,s.jsxs)(e.p,{children:["In this use case, you have multiple sets of documentation (a.k.a. ",(0,s.jsx)(e.a,{href:"https://docusaurus.io/docs/docs-multi-instance",children:"Docs Multi-instance"}),"), then you need to add a reference to ",(0,s.jsx)(e.code,{children:"sidebar-schema.js"})," into the dedicated instance of ",(0,s.jsx)(e.code,{children:"@docusaurus/plugin-content-docs"}),":"]}),"\n",(0,s.jsx)(e.pre,{children:(0,s.jsx)(e.code,{className:"language-js",metastring:'title="docusaurus.config.js"',children:'plugins: [\n [\n "@docusaurus/plugin-content-docs",\n /** @type {import(\'@graphql-markdown/types\').ConfigOptions} */\n {\n id: "api",\n path: "api",\n routeBasePath: "api",\n /// highlight-next-line\n sidebarPath: require.resolve("./api/sidebar-schema.js"),\n // ... other options\n },\n ],\n],\n'})})]})}function l(n={}){const{wrapper:e}={...(0,a.R)(),...n.components};return e?(0,s.jsx)(e,{...n,children:(0,s.jsx)(u,{...n})}):u(n)}},28453:(n,e,t)=>{t.d(e,{R:()=>i,x:()=>c});var s=t(96540);const a={},o=s.createContext(a);function i(n){const e=s.useContext(o);return s.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function c(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(a):n.components||a:i(n.components),s.createElement(o.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/ab25c79e.62e1fbc7.js b/assets/js/ab25c79e.62e1fbc7.js new file mode 100644 index 000000000..2739ede60 --- /dev/null +++ b/assets/js/ab25c79e.62e1fbc7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[4453],{17178:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var r=t(74848),i=t(28453);const s={title:"object",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},o=void 0,l={id:"utils/object",title:"object",description:"Internal library of helpers for manipulating objects.",source:"@site/api/utils/object.md",sourceDirName:"utils",slug:"/utils/object",permalink:"/api/utils/object",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"object",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},a={},c=[{value:"isEmpty()",id:"isempty",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3}];function d(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"Internal library of helpers for manipulating objects."}),"\n",(0,r.jsx)(n.h2,{id:"isempty",children:"isEmpty()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function isEmpty(obj): boolean\n"})}),"\n",(0,r.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"obj"}),": ",(0,r.jsx)(n.code,{children:"unknown"})]}),"\n",(0,r.jsx)(n.p,{children:"the key/value record object."}),"\n",(0,r.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"false"})," if the object is a valid k/v set of records, else ",(0,r.jsx)(n.code,{children:"true"}),"."]}),"\n",(0,r.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/utils/src/object.ts#L34",children:"object.ts:34"})})]})}function u(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},28453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>l});var r=t(96540);const i={},s=r.createContext(i);function o(e){const n=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/ab3156a3.834c8454.js b/assets/js/ab3156a3.834c8454.js new file mode 100644 index 000000000..a5c0a04a7 --- /dev/null +++ b/assets/js/ab3156a3.834c8454.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[9495],{93245:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>s,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var t=r(74848),i=r(28453);const a={title:"interface",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},s=void 0,c={id:"printer-legacy/graphql/interface",title:"interface",description:"printCodeInterface()",source:"@site/api/printer-legacy/graphql/interface.md",sourceDirName:"printer-legacy/graphql",slug:"/printer-legacy/graphql/interface",permalink:"/api/printer-legacy/graphql/interface",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"interface",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},l={},d=[{value:"printCodeInterface()",id:"printcodeinterface",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"printInterfaceMetadata()",id:"printinterfacemetadata",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"printcodeinterface",children:"printCodeInterface()"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function printCodeInterface(type, options): string\n"})}),"\n",(0,t.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"type"}),": ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options"}),": ",(0,t.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,t.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"string"})}),"\n",(0,t.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/graphql/interface.ts#L7",children:"graphql/interface.ts:7"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"printinterfacemetadata",children:"printInterfaceMetadata()"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function printInterfaceMetadata(type, options): string\n"})}),"\n",(0,t.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"type"}),": ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options"}),": ",(0,t.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,t.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"string"})}),"\n",(0,t.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/graphql/interface.ts#L5",children:"graphql/interface.ts:5"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>c});var t=r(96540);const i={},a=t.createContext(i);function s(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/abd6157e.1a9d1800.js b/assets/js/abd6157e.1a9d1800.js new file mode 100644 index 000000000..0291b6941 --- /dev/null +++ b/assets/js/abd6157e.1a9d1800.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[9662],{31521:(e,n,t)=>{t.r(n),t.d(n,{Badge:()=>p,Bullet:()=>l,Details:()=>f,SpecifiedBy:()=>m,assets:()=>d,contentTitle:()=>i,default:()=>h,frontMatter:()=>c,metadata:()=>a,toc:()=>u});var o=t(74848),r=t(28453),s=t(96540);const c={id:"no-doc",title:"noDoc"},i=void 0,a={id:"common/directives/no-doc",title:"noDoc",description:"Example of custom directive for skipDocDirective.",source:"@site/examples/group-by/common/directives/no-doc.mdx",sourceDirName:"common/directives",slug:"/common/directives/no-doc",permalink:"/examples/group-by/common/directives/no-doc",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{id:"no-doc",title:"noDoc"},sidebar:"schemaSidebar",previous:{title:"include",permalink:"/examples/group-by/common/directives/include"},next:{title:"oneOf",permalink:"/examples/group-by/common/directives/one-of"}},d={},l=()=>{const e={span:"span",...(0,r.R)()};return(0,o.jsx)(o.Fragment,{children:(0,o.jsx)(e.span,{style:{fontWeight:"normal",fontSize:".5em",color:"var(--ifm-color-secondary-darkest)"},children:"\xa0\u25cf\xa0"})})},m=e=>{const n={a:"a",...(0,r.R)()};return(0,o.jsxs)(o.Fragment,{children:["Specification",(0,o.jsx)(n.a,{className:"link",style:{fontSize:"1.5em",paddingLeft:"4px"},target:"_blank",href:e.url,title:"Specified by "+e.url,children:"\u2398"})]})},p=e=>{const n={span:"span",...(0,r.R)()};return(0,o.jsx)(o.Fragment,{children:(0,o.jsx)(n.span,{className:e.class,children:e.text})})},u=[],f=({dataOpen:e,dataClose:n,children:t,startOpen:c=!1})=>{const i={details:"details",summary:"summary",...(0,r.R)()},[a,d]=(0,s.useState)(c);return(0,o.jsxs)(i.details,{...a?{open:!0}:{},className:"details",style:{border:"none",boxShadow:"none",background:"var(--ifm-background-color)"},children:[(0,o.jsx)(i.summary,{onClick:e=>{e.preventDefault(),d((e=>!e))},style:{listStyle:"none"},children:a?e:n}),a&&t]})};function x(e){const n={a:"a",code:"code",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(n.p,{children:["Example of custom directive for ",(0,o.jsx)(n.code,{children:"skipDocDirective"}),"."]}),"\n",(0,o.jsxs)(n.p,{children:["See ",(0,o.jsx)(n.a,{href:"https://graphql-markdown.dev/docs/settings#skipdocdirective",children:"documentation"})]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-graphql",children:"directive @noDoc on \r\n | OBJECT\r\n | INTERFACE\r\n | FIELD_DEFINITION\r\n | SCALAR\n"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(x,{...e})}):x(e)}},28453:(e,n,t)=>{t.d(n,{R:()=>c,x:()=>i});var o=t(96540);const r={},s=o.createContext(r);function c(e){const n=o.useContext(s);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),o.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/aeddb196.9b060439.js b/assets/js/aeddb196.9b060439.js new file mode 100644 index 000000000..cf4f224eb --- /dev/null +++ b/assets/js/aeddb196.9b060439.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[8155],{61007:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>p,frontMatter:()=>o,metadata:()=>c,toc:()=>l});var t=r(74848),i=r(28453);const o={title:"group",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},s=void 0,c={id:"printer-legacy/group",title:"group",description:"getGroup()",source:"@site/api/printer-legacy/group.md",sourceDirName:"printer-legacy",slug:"/printer-legacy/group",permalink:"/api/printer-legacy/group",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"group",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},a={},l=[{value:"getGroup()",id:"getgroup",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3}];function d(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"getgroup",children:"getGroup()"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function getGroup(\n type, \n groups, \n typeCategory): string\n"})}),"\n",(0,t.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"type"}),": ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"groups"}),": ",(0,t.jsx)(n.code,{children:"Maybe"}),"<",(0,t.jsx)(n.code,{children:"Partial"}),"<",(0,t.jsx)(n.code,{children:"Record"}),"<",(0,t.jsx)(n.code,{children:"SchemaEntity"}),", ",(0,t.jsx)(n.code,{children:"Record"}),"<",(0,t.jsx)(n.code,{children:"string"}),", ",(0,t.jsx)(n.code,{children:"Maybe"}),"<",(0,t.jsx)(n.code,{children:"string"}),">>>>>"]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"typeCategory"}),": ",(0,t.jsx)(n.code,{children:"Maybe"}),"<",(0,t.jsx)(n.code,{children:"SchemaEntity"}),">"]}),"\n",(0,t.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"string"})}),"\n",(0,t.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/group.ts#L12",children:"group.ts:12"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(d,{...e})}):d(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>c});var t=r(96540);const i={},o=t.createContext(i);function s(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/af7f826a.a26e16ca.js b/assets/js/af7f826a.a26e16ca.js new file mode 100644 index 000000000..235ec0ea8 --- /dev/null +++ b/assets/js/af7f826a.a26e16ca.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[3680],{39118:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>t,default:()=>h,frontMatter:()=>d,metadata:()=>a,toc:()=>c});var s=i(74848),r=i(28453);const d={title:"strings",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},t=void 0,a={id:"printer-legacy/const/strings",title:"strings",description:"DEPRECATED",source:"@site/api/printer-legacy/const/strings.md",sourceDirName:"printer-legacy/const",slug:"/printer-legacy/const/strings",permalink:"/api/printer-legacy/const/strings",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"strings",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},l={},c=[{value:"DEPRECATED",id:"deprecated",level:2},{value:"Defined in",id:"defined-in",level:3},{value:"FRONT_MATTER_DELIMITER",id:"front_matter_delimiter",level:2},{value:"Defined in",id:"defined-in-1",level:3},{value:"HIDE_DEPRECATED",id:"hide_deprecated",level:2},{value:"Defined in",id:"defined-in-2",level:3},{value:"MARKDOWN_CODE_INDENTATION",id:"markdown_code_indentation",level:2},{value:"Defined in",id:"defined-in-3",level:3},{value:"MARKDOWN_EOC",id:"markdown_eoc",level:2},{value:"Defined in",id:"defined-in-4",level:3},{value:"MARKDOWN_EOL",id:"markdown_eol",level:2},{value:"Defined in",id:"defined-in-5",level:3},{value:"MARKDOWN_EOP",id:"markdown_eop",level:2},{value:"Defined in",id:"defined-in-6",level:3},{value:"MARKDOWN_SOC",id:"markdown_soc",level:2},{value:"Defined in",id:"defined-in-7",level:3},{value:"NO_DESCRIPTION_TEXT",id:"no_description_text",level:2},{value:"Defined in",id:"defined-in-8",level:3},{value:"ROOT_TYPE_LOCALE",id:"root_type_locale",level:2},{value:"Defined in",id:"defined-in-9",level:3},{value:"SHOW_DEPRECATED",id:"show_deprecated",level:2},{value:"Defined in",id:"defined-in-10",level:3}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.h2,{id:"deprecated",children:"DEPRECATED"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'const DEPRECATED: "deprecated";\n'})}),"\n",(0,s.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/const/strings.ts#L27",children:"const/strings.ts:27"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"front_matter_delimiter",children:"FRONT_MATTER_DELIMITER"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'const FRONT_MATTER_DELIMITER: "---";\n'})}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/const/strings.ts#L19",children:"const/strings.ts:19"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"hide_deprecated",children:"HIDE_DEPRECATED"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'const HIDE_DEPRECATED: "<>Hide deprecated";\n'})}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/const/strings.ts#L29",children:"const/strings.ts:29"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"markdown_code_indentation",children:"MARKDOWN_CODE_INDENTATION"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'const MARKDOWN_CODE_INDENTATION: " ";\n'})}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/const/strings.ts#L20",children:"const/strings.ts:20"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"markdown_eoc",children:"MARKDOWN_EOC"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'const MARKDOWN_EOC: "\\n``\\n";\n'})}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/const/strings.ts#L23",children:"const/strings.ts:23"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"markdown_eol",children:"MARKDOWN_EOL"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'const MARKDOWN_EOL: "\\n";\n'})}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/const/strings.ts#L21",children:"const/strings.ts:21"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"markdown_eop",children:"MARKDOWN_EOP"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'const MARKDOWN_EOP: "\\n\\n";\n'})}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/const/strings.ts#L22",children:"const/strings.ts:22"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"markdown_soc",children:"MARKDOWN_SOC"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'const MARKDOWN_SOC: "\\n``graphql\\n";\n'})}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/const/strings.ts#L24",children:"const/strings.ts:24"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"no_description_text",children:"NO_DESCRIPTION_TEXT"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'const NO_DESCRIPTION_TEXT: "No description";\n'})}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/const/strings.ts#L17",children:"const/strings.ts:17"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"root_type_locale",children:"ROOT_TYPE_LOCALE"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"const ROOT_TYPE_LOCALE: RootTypeLocale;\n"})}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/const/strings.ts#L3",children:"const/strings.ts:3"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"show_deprecated",children:"SHOW_DEPRECATED"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'const SHOW_DEPRECATED: "<>Show deprecated";\n'})}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/const/strings.ts#L31",children:"const/strings.ts:31"})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},28453:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>a});var s=i(96540);const r={},d=s.createContext(r);function t(e){const n=s.useContext(d);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),s.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b1aa3f71.9c4fd7d6.js b/assets/js/b1aa3f71.9c4fd7d6.js new file mode 100644 index 000000000..169ddbc15 --- /dev/null +++ b/assets/js/b1aa3f71.9c4fd7d6.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[9038],{51082:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>l,default:()=>m,frontMatter:()=>s,metadata:()=>u,toc:()=>p});var r=t(74848),a=t(28453),i=t(49489),o=t(7227);const s={id:"schema",slug:"/",title:"Schema Documentation",sidebar_position:1,hide_table_of_contents:!0,pagination_next:null,pagination_prev:null,sidebar_class_name:"navbar__toggle"},l=void 0,u={id:"schema",title:"Schema Documentation",description:"This is an example of documentation grouping with GraphQL directive using the groupByDirective option (see documentation):",source:"@site/examples/group-by/groups.md",sourceDirName:".",slug:"/",permalink:"/examples/group-by/",draft:!1,unlisted:!1,tags:[],version:"current",sidebarPosition:1,frontMatter:{id:"schema",slug:"/",title:"Schema Documentation",sidebar_position:1,hide_table_of_contents:!0,pagination_next:null,pagination_prev:null,sidebar_class_name:"navbar__toggle"},sidebar:"schemaSidebar"},c={},p=[];function d(e){const n={a:"a",code:"code",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsxs)(n.p,{children:["This is an example of documentation grouping with GraphQL directive using the ",(0,r.jsx)(n.code,{children:"groupByDirective"})," option (see ",(0,r.jsx)(n.a,{href:"/docs/advanced/group-by-directive",children:"documentation"}),"):"]}),"\n",(0,r.jsxs)(i.A,{groupId:"config",children:[(0,r.jsx)(o.A,{value:"docusaurus",label:"Docusaurus (JS/TS)",children:(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-js",children:'{\n schema: "data/schema_with_grouping.graphql",\n baseURL: ".",\n linkRoot: "/examples/group-by",\n homepage: "data/groups.md",\n groupByDirective: {\n directive: "doc",\n field: "category",\n fallback: "Common"\n },\n docOptions: {\n index: true,\n },\n printTypeOptions: {\n deprecated: "group",\n exampleSection: true,\n parentTypePrefix: false,\n relatedTypeSection: false,\n typeBadges: true,\n useApiGroup: false,\n },\n skipDocDirective: ["@noDoc"],\n customDirective: {\n auth: {\n descriptor: (directive, type) =>\n directiveDescriptor(\n directive,\n type,\n "This requires the current user to be in `${requires}` role.",\n ),\n },\n complexity: {\n descriptor: (directive, type) => {\n const { value, multipliers } = getTypeDirectiveValues(directive, type);\n const multiplierDescription = multipliers\n ? ` per ${multipliers.map((v) => `\\`${v}\\``).join(", ")}`\n : "";\n return `This has an additional cost of \\`${value}\\` points${multiplierDescription}.`;\n },\n },\n },\n}\n'})})}),(0,r.jsx)(o.A,{value:"graphql-config",label:"GraphQL Config (JS/TS)",children:(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-js",children:'{\n schema: "data/schema_with_grouping.graphql",\n extensions: {\n "graphql-markdown": {\n baseURL: ".",\n linkRoot: "/examples/group-by",\n homepage: "data/groups.md",\n groupByDirective: {\n directive: "doc",\n field: "category",\n fallback: "Common"\n },\n docOptions: {\n index: true,\n },\n printTypeOptions: {\n deprecated: "group",\n exampleSection: true,\n parentTypePrefix: false,\n relatedTypeSection: false,\n typeBadges: true,\n useApiGroup: false,\n },\n skipDocDirective: ["@noDoc"],\n customDirective: {\n auth: {\n descriptor: (directive, type) =>\n directiveDescriptor(\n directive,\n type,\n "This requires the current user to be in `${requires}` role.",\n ),\n },\n complexity: {\n descriptor: (directive, type) => {\n const { value, multipliers } = getTypeDirectiveValues(directive, type);\n const multiplierDescription = multipliers\n ? ` per ${multipliers.map((v) => `\\`${v}\\``).join(", ")}`\n : "";\n return `This has an additional cost of \\`${value}\\` points${multiplierDescription}.`;\n },\n },\n },\n },\n },\n}\n'})})}),(0,r.jsx)(o.A,{value:"cli",label:"CLI",children:(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-bash",children:"npx docusaurus graphql-to-doc \\\n --homepage data/groups.md \\\n --schema data/schema_with_grouping.graphql \\\n --groupByDirective @doc(category|=Common) \\\n --base . \\\n --link /examples/group-by \\\n --skip @noDoc \\\n --index \\\n --noParentType \\\n --noRelatedType \\\n --deprecated group\n --noApiGroup\n"})})})]}),"\n",(0,r.jsx)("small",{children:(0,r.jsx)("i",{children:"Generated on 6/23/2024, 11:11:42 AM."})})]})}function m(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},7227:(e,n,t)=>{t.d(n,{A:()=>o});t(96540);var r=t(18215);const a={tabItem:"tabItem_Ymn6"};var i=t(74848);function o(e){let{children:n,hidden:t,className:o}=e;return(0,i.jsx)("div",{role:"tabpanel",className:(0,r.A)(a.tabItem,o),hidden:t,children:n})}},49489:(e,n,t)=>{t.d(n,{A:()=>D});var r=t(96540),a=t(18215),i=t(24245),o=t(56347),s=t(36494),l=t(62814),u=t(45167),c=t(81269);function p(e){return r.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,r.isValidElement)(e)&&function(e){const{props:n}=e;return!!n&&"object"==typeof n&&"value"in n}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}function d(e){const{values:n,children:t}=e;return(0,r.useMemo)((()=>{const e=n??function(e){return p(e).map((e=>{let{props:{value:n,label:t,attributes:r,default:a}}=e;return{value:n,label:t,attributes:r,default:a}}))}(t);return function(e){const n=(0,u.X)(e,((e,n)=>e.value===n.value));if(n.length>0)throw new Error(`Docusaurus error: Duplicate values "${n.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[n,t])}function m(e){let{value:n,tabValues:t}=e;return t.some((e=>e.value===n))}function h(e){let{queryString:n=!1,groupId:t}=e;const a=(0,o.W6)(),i=function(e){let{queryString:n=!1,groupId:t}=e;if("string"==typeof n)return n;if(!1===n)return null;if(!0===n&&!t)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return t??null}({queryString:n,groupId:t});return[(0,l.aZ)(i),(0,r.useCallback)((e=>{if(!i)return;const n=new URLSearchParams(a.location.search);n.set(i,e),a.replace({...a.location,search:n.toString()})}),[i,a])]}function g(e){const{defaultValue:n,queryString:t=!1,groupId:a}=e,i=d(e),[o,l]=(0,r.useState)((()=>function(e){let{defaultValue:n,tabValues:t}=e;if(0===t.length)throw new Error("Docusaurus error: the component requires at least one children component");if(n){if(!m({value:n,tabValues:t}))throw new Error(`Docusaurus error: The has a defaultValue "${n}" but none of its children has the corresponding value. Available values are: ${t.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return n}const r=t.find((e=>e.default))??t[0];if(!r)throw new Error("Unexpected error: 0 tabValues");return r.value}({defaultValue:n,tabValues:i}))),[u,p]=h({queryString:t,groupId:a}),[g,f]=function(e){let{groupId:n}=e;const t=function(e){return e?`docusaurus.tab.${e}`:null}(n),[a,i]=(0,c.Dv)(t);return[a,(0,r.useCallback)((e=>{t&&i.set(e)}),[t,i])]}({groupId:a}),b=(()=>{const e=u??g;return m({value:e,tabValues:i})?e:null})();(0,s.A)((()=>{b&&l(b)}),[b]);return{selectedValue:o,selectValue:(0,r.useCallback)((e=>{if(!m({value:e,tabValues:i}))throw new Error(`Can't select invalid tab value=${e}`);l(e),p(e),f(e)}),[p,f,i]),tabValues:i}}var f=t(11062);const b={tabList:"tabList__CuJ",tabItem:"tabItem_LNqP"};var v=t(74848);function y(e){let{className:n,block:t,selectedValue:r,selectValue:o,tabValues:s}=e;const l=[],{blockElementScrollPositionUntilNextRender:u}=(0,i.a_)(),c=e=>{const n=e.currentTarget,t=l.indexOf(n),a=s[t].value;a!==r&&(u(n),o(a))},p=e=>{let n=null;switch(e.key){case"Enter":c(e);break;case"ArrowRight":{const t=l.indexOf(e.currentTarget)+1;n=l[t]??l[0];break}case"ArrowLeft":{const t=l.indexOf(e.currentTarget)-1;n=l[t]??l[l.length-1];break}}n?.focus()};return(0,v.jsx)("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,a.A)("tabs",{"tabs--block":t},n),children:s.map((e=>{let{value:n,label:t,attributes:i}=e;return(0,v.jsx)("li",{role:"tab",tabIndex:r===n?0:-1,"aria-selected":r===n,ref:e=>l.push(e),onKeyDown:p,onClick:c,...i,className:(0,a.A)("tabs__item",b.tabItem,i?.className,{"tabs__item--active":r===n}),children:t??n},n)}))})}function x(e){let{lazy:n,children:t,selectedValue:a}=e;const i=(Array.isArray(t)?t:[t]).filter(Boolean);if(n){const e=i.find((e=>e.props.value===a));return e?(0,r.cloneElement)(e,{className:"margin-top--md"}):null}return(0,v.jsx)("div",{className:"margin-top--md",children:i.map(((e,n)=>(0,r.cloneElement)(e,{key:n,hidden:e.props.value!==a})))})}function _(e){const n=g(e);return(0,v.jsxs)("div",{className:(0,a.A)("tabs-container",b.tabList),children:[(0,v.jsx)(y,{...e,...n}),(0,v.jsx)(x,{...e,...n})]})}function D(e){const n=(0,f.A)();return(0,v.jsx)(_,{...e,children:p(e.children)},String(n))}},28453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>s});var r=t(96540);const a={},i=r.createContext(a);function o(e){const n=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),r.createElement(i.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b48f7d9d.6277b3c4.js b/assets/js/b48f7d9d.6277b3c4.js new file mode 100644 index 000000000..c5b32c1f4 --- /dev/null +++ b/assets/js/b48f7d9d.6277b3c4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[8577],{57033:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var i=r(74848),s=r(28453);const t={title:"directive",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},d=void 0,c={id:"printer-legacy/directive",title:"directive",description:"getCustomDirectiveResolver()",source:"@site/api/printer-legacy/directive.md",sourceDirName:"printer-legacy",slug:"/printer-legacy/directive",permalink:"/api/printer-legacy/directive",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"directive",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},l={},a=[{value:"getCustomDirectiveResolver()",id:"getcustomdirectiveresolver",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"getCustomTags()",id:"getcustomtags",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3},{value:"printCustomDirective()",id:"printcustomdirective",level:2},{value:"Parameters",id:"parameters-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Defined in",id:"defined-in-2",level:3},{value:"printCustomDirectives()",id:"printcustomdirectives",level:2},{value:"Parameters",id:"parameters-3",level:3},{value:"Returns",id:"returns-3",level:3},{value:"Defined in",id:"defined-in-3",level:3},{value:"printCustomTags()",id:"printcustomtags",level:2},{value:"Parameters",id:"parameters-4",level:3},{value:"Returns",id:"returns-4",level:3},{value:"Defined in",id:"defined-in-4",level:3}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"getcustomdirectiveresolver",children:"getCustomDirectiveResolver()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function getCustomDirectiveResolver(\n resolver, \n type, \n constDirectiveOption, \nfallback?): Maybe\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"resolver"}),": ",(0,i.jsx)(n.code,{children:"CustomDirectiveResolver"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"constDirectiveOption"}),": ",(0,i.jsx)(n.code,{children:"CustomDirectiveMapItem"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"fallback?"}),": ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,i.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/directive.ts#L17",children:"directive.ts:17"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"getcustomtags",children:"getCustomTags()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function getCustomTags(type, options): Badge[]\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Badge"}),"[]"]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/directive.ts#L89",children:"directive.ts:89"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"printcustomdirective",children:"printCustomDirective()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printCustomDirective(\n type, \n constDirectiveOption, \noptions): Maybe\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"constDirectiveOption"}),": ",(0,i.jsx)(n.code,{children:"CustomDirectiveMapItem"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/directive.ts#L37",children:"directive.ts:37"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"printcustomdirectives",children:"printCustomDirectives()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printCustomDirectives(type, options): string\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-3",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-3",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"string"})}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/directive.ts#L59",children:"directive.ts:59"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"printcustomtags",children:"printCustomTags()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printCustomTags(type, options): string | MDXString\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-4",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-4",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-4",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/directive.ts#L115",children:"directive.ts:115"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>d,x:()=>c});var i=r(96540);const s={},t=i.createContext(s);function d(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b835b301.51b75b23.js b/assets/js/b835b301.51b75b23.js new file mode 100644 index 000000000..fe804b9cd --- /dev/null +++ b/assets/js/b835b301.51b75b23.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[1713],{48611:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>l,default:()=>h,frontMatter:()=>t,metadata:()=>c,toc:()=>a});var i=r(74848),s=r(28453);const t={title:"section",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},l=void 0,c={id:"printer-legacy/section",title:"section",description:"sectionLevels",source:"@site/api/printer-legacy/section.md",sourceDirName:"printer-legacy",slug:"/printer-legacy/section",permalink:"/api/printer-legacy/section",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"section",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},d={},a=[{value:"sectionLevels",id:"sectionlevels",level:2},{value:"Defined in",id:"defined-in",level:3},{value:"printMetadataSection()",id:"printmetadatasection",level:2},{value:"Type Parameters",id:"type-parameters",level:3},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in-1",level:3},{value:"printSection()",id:"printsection",level:2},{value:"Type Parameters",id:"type-parameters-1",level:3},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-2",level:3},{value:"printSectionItem()",id:"printsectionitem",level:2},{value:"Type Parameters",id:"type-parameters-2",level:3},{value:"Parameters",id:"parameters-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Defined in",id:"defined-in-3",level:3},{value:"printSectionItems()",id:"printsectionitems",level:2},{value:"Type Parameters",id:"type-parameters-3",level:3},{value:"Parameters",id:"parameters-3",level:3},{value:"Returns",id:"returns-3",level:3},{value:"Defined in",id:"defined-in-4",level:3}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"sectionlevels",children:"sectionLevels"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"const sectionLevels: SectionLevel[];\n"})}),"\n",(0,i.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/section.ts#L24",children:"section.ts:24"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"printmetadatasection",children:"printMetadataSection()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printMetadataSection(\n type, \n values, \n section, \n options): string | MDXString\n"})}),"\n",(0,i.jsx)(n.h3,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"T"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"V"})]}),"\n",(0,i.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"T"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"values"}),": ",(0,i.jsx)(n.code,{children:"V"})," | ",(0,i.jsx)(n.code,{children:"V"}),"[] | readonly ",(0,i.jsx)(n.code,{children:"V"}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"section"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/section.ts#L143",children:"section.ts:143"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"printsection",children:"printSection()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printSection(\n values, \n section, \n options): string | MDXString\n"})}),"\n",(0,i.jsx)(n.h3,{id:"type-parameters-1",children:"Type Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"V"})]}),"\n",(0,i.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"values"}),": ",(0,i.jsx)(n.code,{children:"V"}),"[] | readonly ",(0,i.jsx)(n.code,{children:"V"}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"section"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/section.ts#L98",children:"section.ts:98"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"printsectionitem",children:"printSectionItem()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printSectionItem(type, options): string | MDXString\n"})}),"\n",(0,i.jsx)(n.h3,{id:"type-parameters-2",children:"Type Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"T"})]}),"\n",(0,i.jsx)(n.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"T"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/section.ts#L30",children:"section.ts:30"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"printsectionitems",children:"printSectionItems()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printSectionItems(values, options): string | MDXString\n"})}),"\n",(0,i.jsx)(n.h3,{id:"type-parameters-3",children:"Type Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"V"})]}),"\n",(0,i.jsx)(n.h3,{id:"parameters-3",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"values"}),": ",(0,i.jsx)(n.code,{children:"V"})," | ",(0,i.jsx)(n.code,{children:"V"}),"[]"]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-3",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-4",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/section.ts#L71",children:"section.ts:71"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>l,x:()=>c});var i=r(96540);const s={},t=i.createContext(s);function l(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:l(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/b9652c4a.b9d7b514.js b/assets/js/b9652c4a.b9d7b514.js new file mode 100644 index 000000000..70d89ecfe --- /dev/null +++ b/assets/js/b9652c4a.b9d7b514.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[4703],{38547:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>o,default:()=>p,frontMatter:()=>a,metadata:()=>c,toc:()=>d});var r=t(74848),i=t(28453);const a={title:"mdx",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},o=void 0,c={id:"printer-legacy/const/mdx",title:"mdx",description:"mdx",source:"@site/api/printer-legacy/const/mdx.md",sourceDirName:"printer-legacy/const",slug:"/printer-legacy/const/mdx",permalink:"/api/printer-legacy/const/mdx",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"mdx",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},s={},d=[{value:"mdx",id:"mdx",level:2},{value:"Defined in",id:"defined-in",level:3}];function l(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"mdx",children:"mdx"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"const mdx: MDXString;\n"})}),"\n",(0,r.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/const/mdx.ts#L3",children:"const/mdx.ts:3"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},28453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>c});var r=t(96540);const i={},a=r.createContext(i);function o(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bcab2f54.ed4b2e71.js b/assets/js/bcab2f54.ed4b2e71.js new file mode 100644 index 000000000..ef4ce309f --- /dev/null +++ b/assets/js/bcab2f54.ed4b2e71.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[9548],{90252:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>o,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>a,toc:()=>c});var i=r(74848),s=r(28453);const t={title:"diff",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},d=void 0,a={id:"core/diff",title:"diff",description:"hasChanges()",source:"@site/api/core/diff.md",sourceDirName:"core",slug:"/core/diff",permalink:"/api/core/diff",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"diff",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},o={},c=[{value:"hasChanges()",id:"haschanges",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3}];function l(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,s.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"haschanges",children:"hasChanges()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function hasChanges(\n schema, \n tmpDir, \n diffMethod, \ndiffModule): Promise\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"schema"}),": ",(0,i.jsx)(n.code,{children:"GraphQLSchema"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"tmpDir"}),": ",(0,i.jsx)(n.code,{children:"string"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"diffMethod"}),": ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"DiffMethodName"}),">"]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"diffModule"}),": ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"string"}),"> = ",(0,i.jsx)(n.code,{children:'"@graphql-markdown/diff"'})]}),"\n",(0,i.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Promise"}),"<",(0,i.jsx)(n.code,{children:"boolean"}),">"]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/diff.ts#L10",children:"diff.ts:10"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(l,{...e})}):l(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>d,x:()=>a});var i=r(96540);const s={},t=i.createContext(s);function d(e){const n=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),i.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/bff4d555.f0b15209.js b/assets/js/bff4d555.f0b15209.js new file mode 100644 index 000000000..0e3acbb9c --- /dev/null +++ b/assets/js/bff4d555.f0b15209.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[690],{32033:(n,e,r)=>{r.r(e),r.d(e,{assets:()=>o,contentTitle:()=>s,default:()=>p,frontMatter:()=>a,metadata:()=>l,toc:()=>d});var i=r(74848),t=r(28453);const a={title:"union",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},s=void 0,l={id:"printer-legacy/graphql/union",title:"union",description:"printCodeUnion()",source:"@site/api/printer-legacy/graphql/union.md",sourceDirName:"printer-legacy/graphql",slug:"/printer-legacy/graphql/union",permalink:"/api/printer-legacy/graphql/union",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"union",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},o={},d=[{value:"printCodeUnion()",id:"printcodeunion",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"printUnionMetadata()",id:"printunionmetadata",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3}];function c(n){const e={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...n.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(e.h2,{id:"printcodeunion",children:"printCodeUnion()"}),"\n",(0,i.jsx)(e.pre,{children:(0,i.jsx)(e.code,{className:"language-ts",children:"function printCodeUnion(type, options?): string\n"})}),"\n",(0,i.jsx)(e.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"type"}),": ",(0,i.jsx)(e.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"options?"}),": ",(0,i.jsx)(e.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(e.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.code,{children:"string"})}),"\n",(0,i.jsx)(e.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/graphql/union.ts#L25",children:"graphql/union.ts:25"})}),"\n",(0,i.jsx)(e.hr,{}),"\n",(0,i.jsx)(e.h2,{id:"printunionmetadata",children:"printUnionMetadata()"}),"\n",(0,i.jsx)(e.pre,{children:(0,i.jsx)(e.code,{className:"language-ts",children:"function printUnionMetadata(type, options): string | MDXString\n"})}),"\n",(0,i.jsx)(e.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"type"}),": ",(0,i.jsx)(e.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(e.p,{children:["\u2022 ",(0,i.jsx)(e.strong,{children:"options"}),": ",(0,i.jsx)(e.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(e.h3,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsxs)(e.p,{children:[(0,i.jsx)(e.code,{children:"string"})," | ",(0,i.jsx)(e.code,{children:"MDXString"})]}),"\n",(0,i.jsx)(e.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(e.p,{children:(0,i.jsx)(e.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/graphql/union.ts#L11",children:"graphql/union.ts:11"})})]})}function p(n={}){const{wrapper:e}={...(0,t.R)(),...n.components};return e?(0,i.jsx)(e,{...n,children:(0,i.jsx)(c,{...n})}):c(n)}},28453:(n,e,r)=>{r.d(e,{R:()=>s,x:()=>l});var i=r(96540);const t={},a=i.createContext(t);function s(n){const e=i.useContext(a);return i.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function l(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(t):n.components||t:s(n.components),i.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/c14b7bba.140ba76d.js b/assets/js/c14b7bba.140ba76d.js new file mode 100644 index 000000000..dd3ce16b4 --- /dev/null +++ b/assets/js/c14b7bba.140ba76d.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[637],{37820:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>d,contentTitle:()=>s,default:()=>h,frontMatter:()=>i,metadata:()=>l,toc:()=>c});var a=n(74848),t=n(28453);const i={title:"array",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},s=void 0,l={id:"utils/array",title:"array",description:"Internal library of helpers for manipulating array and list.",source:"@site/api/utils/array.md",sourceDirName:"utils",slug:"/utils/array",permalink:"/api/utils/array",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"array",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},d={},c=[{value:"convertArrayToMapObject()",id:"convertarraytomapobject",level:2},{value:"Type Parameters",id:"type-parameters",level:3},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"toArray()",id:"toarray",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3}];function o(e){const r={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(r.p,{children:"Internal library of helpers for manipulating array and list."}),"\n",(0,a.jsx)(r.h2,{id:"convertarraytomapobject",children:"convertArrayToMapObject()"}),"\n",(0,a.jsx)(r.pre,{children:(0,a.jsx)(r.code,{className:"language-ts",children:"function convertArrayToMapObject(list): Maybe>\n"})}),"\n",(0,a.jsx)(r.h3,{id:"type-parameters",children:"Type Parameters"}),"\n",(0,a.jsxs)(r.p,{children:["\u2022 ",(0,a.jsx)(r.strong,{children:"T"})]}),"\n",(0,a.jsx)(r.p,{children:"the type of objects the list contains."}),"\n",(0,a.jsx)(r.h3,{id:"parameters",children:"Parameters"}),"\n",(0,a.jsxs)(r.p,{children:["\u2022 ",(0,a.jsx)(r.strong,{children:"list"}),": ",(0,a.jsx)(r.code,{children:"Maybe"}),"<",(0,a.jsx)(r.code,{children:"T"}),"[]>"]}),"\n",(0,a.jsxs)(r.p,{children:["the list of objects of type ",(0,a.jsx)(r.code,{children:"{ name: any }"})," to be converted."]}),"\n",(0,a.jsx)(r.h3,{id:"returns",children:"Returns"}),"\n",(0,a.jsxs)(r.p,{children:[(0,a.jsx)(r.code,{children:"Maybe"}),"<",(0,a.jsx)(r.code,{children:"Record"}),"<",(0,a.jsx)(r.code,{children:"string"}),", ",(0,a.jsx)(r.code,{children:"T"}),">>"]}),"\n",(0,a.jsxs)(r.p,{children:["an array of object values with ",(0,a.jsx)(r.code,{children:"name"})," as key, or ",(0,a.jsx)(r.code,{children:"undefined"})," if ",(0,a.jsx)(r.code,{children:"list"})," is not a valid array."]}),"\n",(0,a.jsx)(r.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(r.p,{children:(0,a.jsx)(r.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/utils/src/array.ts#L76",children:"array.ts:76"})}),"\n",(0,a.jsx)(r.hr,{}),"\n",(0,a.jsx)(r.h2,{id:"toarray",children:"toArray()"}),"\n",(0,a.jsx)(r.pre,{children:(0,a.jsx)(r.code,{className:"language-ts",children:"function toArray(recordMap): Maybe\n"})}),"\n",(0,a.jsx)(r.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,a.jsxs)(r.p,{children:["\u2022 ",(0,a.jsx)(r.strong,{children:"recordMap"}),": ",(0,a.jsx)(r.code,{children:"Maybe"}),"<",(0,a.jsx)(r.code,{children:"Record"}),"<",(0,a.jsx)(r.code,{children:"string"}),", ",(0,a.jsx)(r.code,{children:"unknown"}),">>"]}),"\n",(0,a.jsx)(r.p,{children:"the key/value record object to be converted."}),"\n",(0,a.jsx)(r.h3,{id:"returns-1",children:"Returns"}),"\n",(0,a.jsxs)(r.p,{children:[(0,a.jsx)(r.code,{children:"Maybe"}),"<",(0,a.jsx)(r.code,{children:"unknown"}),"[]>"]}),"\n",(0,a.jsxs)(r.p,{children:["an array of object values, or ",(0,a.jsx)(r.code,{children:"undefined"})," if ",(0,a.jsx)(r.code,{children:"recordMap"})," is not a valid object."]}),"\n",(0,a.jsx)(r.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,a.jsx)(r.p,{children:(0,a.jsx)(r.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/utils/src/array.ts#L34",children:"array.ts:34"})})]})}function h(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,a.jsx)(r,{...e,children:(0,a.jsx)(o,{...e})}):o(e)}},28453:(e,r,n)=>{n.d(r,{R:()=>s,x:()=>l});var a=n(96540);const t={},i=a.createContext(t);function s(e){const r=a.useContext(i);return a.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function l(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),a.createElement(i.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/c49f35ad.8dec64d2.js b/assets/js/c49f35ad.8dec64d2.js new file mode 100644 index 000000000..669d97bbe --- /dev/null +++ b/assets/js/c49f35ad.8dec64d2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[6152],{82076:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>p,frontMatter:()=>a,metadata:()=>d,toc:()=>l});var r=i(74848),t=i(28453);const a={title:"tag",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},s=void 0,d={id:"helpers/directives/tag",title:"tag",description:"Custom directive tag helper.",source:"@site/api/helpers/directives/tag.md",sourceDirName:"helpers/directives",slug:"/helpers/directives/tag",permalink:"/api/helpers/directives/tag",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"tag",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},c={},l=[{value:"See",id:"see",level:2},{value:"directiveTag()",id:"directivetag",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Example",id:"example",level:3},{value:"Defined in",id:"defined-in",level:3}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,t.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsxs)(n.p,{children:["Custom directive ",(0,r.jsx)(n.code,{children:"tag"})," helper."]}),"\n",(0,r.jsx)(n.h2,{id:"see",children:"See"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsxs)(n.a,{href:"https://graphql-markdown.dev/docs/advanced/custom-directive#tag",children:["Option ",(0,r.jsx)(n.code,{children:"customDirective.[directive].tag"})]})}),"\n",(0,r.jsx)(n.h2,{id:"directivetag",children:"directiveTag()"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"function directiveTag(\n directive, \n type?, \n classname?): Badge\n"})}),"\n",(0,r.jsxs)(n.p,{children:["Helper for rendering custom description from schema directive on type.\nThis is an example on how to build a custom ",(0,r.jsx)(n.code,{children:"tag"})," callback."]}),"\n",(0,r.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"directive"}),": ",(0,r.jsx)(n.code,{children:"GraphQLDirective"})]}),"\n",(0,r.jsx)(n.p,{children:"the schema directive to parse."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"type?"}),": ",(0,r.jsx)(n.code,{children:"unknown"})]}),"\n",(0,r.jsx)(n.p,{children:"the type being processed."}),"\n",(0,r.jsxs)(n.p,{children:["\u2022 ",(0,r.jsx)(n.strong,{children:"classname?"}),": ",(0,r.jsx)(n.code,{children:"string"})," = ",(0,r.jsx)(n.code,{children:'"badge--secondary"'})]}),"\n",(0,r.jsxs)(n.p,{children:["optional CSS classname, ",(0,r.jsx)(n.code,{children:'"badge--secondary"'})," by default."]}),"\n",(0,r.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"Badge"})}),"\n",(0,r.jsx)(n.p,{children:"a custom description based on directive value."}),"\n",(0,r.jsx)(n.h3,{id:"example",children:"Example"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-js",children:'import { GraphQLDirective, GraphQLScalarType } from "graphql";\nimport { directiveTag } from "@graphql-markdown/helpers/directives/tag";\n\nconst directive = new GraphQLDirective({\n name: "auth",\n description: "Authentication required",\n locations: [],\n});\n\nconst type = new GraphQLScalarType({\n name: "FooBar",\n astNode: {\n kind: Kind.SCALAR_TYPE_DEFINITION,\n name: { kind: Kind.NAME, value: "FooBar" },\n directives: [\n {\n kind: Kind.DIRECTIVE,\n name: { kind: Kind.NAME, value: "auth" },\n },\n ],\n },\n});\n\ndirectiveTag(directive, type);\n// Expected result: { text: "@auth", classname: "badge--secondary" }\n'})}),"\n",(0,r.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/helpers/src/directives/tag.ts#L51",children:"directives/tag.ts:51"})})]})}function p(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(o,{...e})}):o(e)}},28453:(e,n,i)=>{i.d(n,{R:()=>s,x:()=>d});var r=i(96540);const t={},a=r.createContext(t);function s(e){const n=r.useContext(a);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),r.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/cb0f12d1.9b90d790.js b/assets/js/cb0f12d1.9b90d790.js new file mode 100644 index 000000000..d37e0b56b --- /dev/null +++ b/assets/js/cb0f12d1.9b90d790.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[3902],{72609:(e,t,o)=>{o.r(t),o.d(t,{assets:()=>d,contentTitle:()=>a,default:()=>u,frontMatter:()=>s,metadata:()=>i,toc:()=>p});var n=o(74848),r=o(28453);const s={pagination_prev:null,pagination_next:null},a="Custom root types",i={id:"advanced/custom-root-types",title:"Custom root types",description:"For custom operation root types (queries not of type Query, or root type name used for other purpose), use the loader option RootTypes:",source:"@site/docs/advanced/custom-root-types.md",sourceDirName:"advanced",slug:"/advanced/custom-root-types",permalink:"/docs/advanced/custom-root-types",draft:!1,unlisted:!1,editUrl:"https://github.com/graphql-markdown/graphql-markdown/tree/main/docs/advanced/custom-root-types.md",tags:[],version:"current",frontMatter:{pagination_prev:null,pagination_next:null},sidebar:"defaultSidebar"},d={},p=[];function c(e){const t={a:"a",code:"code",h1:"h1",li:"li",p:"p",pre:"pre",ul:"ul",...(0,r.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h1,{id:"custom-root-types",children:"Custom root types"}),"\n",(0,n.jsxs)(t.p,{children:["For custom operation root types (queries not of type ",(0,n.jsx)(t.code,{children:"Query"}),", or root type name used for other purpose), use the loader option ",(0,n.jsx)(t.code,{children:"RootTypes"}),":"]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-ts",children:"type RootTypes = { query?: string; mutation?: string; subscription?: string };\n"})}),"\n",(0,n.jsxs)(t.ul,{children:["\n",(0,n.jsx)(t.li,{children:"use a custom type name to override the standard type\nuse an empty string to disable the GraphQL standard type"}),"\n",(0,n.jsx)(t.li,{children:"unset root types will use the GraphQL standard type"}),"\n"]}),"\n",(0,n.jsxs)(t.p,{children:["Add the option ",(0,n.jsx)(t.code,{children:"rootTypes"})," to the loader options under ",(0,n.jsx)(t.code,{children:"@graphql-markdown/docusaurus"})," configuration (see also ",(0,n.jsx)(t.a,{href:"/docs/advanced/schema-loading",children:"schema loading"}),"):"]}),"\n",(0,n.jsx)(t.pre,{children:(0,n.jsx)(t.code,{className:"language-js",metastring:'title="docusaurus.config.js"',children:'plugins: [\n [\n "@graphql-markdown/docusaurus",\n /** @type {import(\'@graphql-markdown/types\').ConfigOptions} */\n {\n // ... other options\n loaders: {\n GraphQLFileLoader: {\n module: "@graphql-tools/graphql-file-loader",\n options: {\n // highlight-start\n rootTypes: {\n query: "Root", // use custom root type Root for queries, instead of Query\n subscription: "" // disable Subscription type\n },\n // highlight-end\n },\n },\n },\n },\n ],\n],\n'})})]})}function u(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(c,{...e})}):c(e)}},28453:(e,t,o)=>{o.d(t,{R:()=>a,x:()=>i});var n=o(96540);const r={},s=n.createContext(r);function a(e){const t=n.useContext(s);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function i(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:a(e.components),n.createElement(s.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d262eff2.e37dcf97.js b/assets/js/d262eff2.e37dcf97.js new file mode 100644 index 000000000..88ae8b278 --- /dev/null +++ b/assets/js/d262eff2.e37dcf97.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[7296],{7510:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>p,contentTitle:()=>s,default:()=>o,frontMatter:()=>a,metadata:()=>l,toc:()=>d});var r=t(74848),i=t(28453);const a={title:"input",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},s=void 0,l={id:"printer-legacy/graphql/input",title:"input",description:"printCodeInput()",source:"@site/api/printer-legacy/graphql/input.md",sourceDirName:"printer-legacy/graphql",slug:"/printer-legacy/graphql/input",permalink:"/api/printer-legacy/graphql/input",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"input",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},p={},d=[{value:"printCodeInput()",id:"printcodeinput",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"printInputMetadata()",id:"printinputmetadata",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3}];function c(n){const e={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...n.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(e.h2,{id:"printcodeinput",children:"printCodeInput()"}),"\n",(0,r.jsx)(e.pre,{children:(0,r.jsx)(e.code,{className:"language-ts",children:"function printCodeInput(type, options): string\n"})}),"\n",(0,r.jsx)(e.h3,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(e.p,{children:["\u2022 ",(0,r.jsx)(e.strong,{children:"type"}),": ",(0,r.jsx)(e.code,{children:"unknown"})]}),"\n",(0,r.jsxs)(e.p,{children:["\u2022 ",(0,r.jsx)(e.strong,{children:"options"}),": ",(0,r.jsx)(e.code,{children:"PrintTypeOptions"})]}),"\n",(0,r.jsx)(e.h3,{id:"returns",children:"Returns"}),"\n",(0,r.jsx)(e.p,{children:(0,r.jsx)(e.code,{children:"string"})}),"\n",(0,r.jsx)(e.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(e.p,{children:(0,r.jsx)(e.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/graphql/input.ts#L7",children:"graphql/input.ts:7"})}),"\n",(0,r.jsx)(e.hr,{}),"\n",(0,r.jsx)(e.h2,{id:"printinputmetadata",children:"printInputMetadata()"}),"\n",(0,r.jsx)(e.pre,{children:(0,r.jsx)(e.code,{className:"language-ts",children:"function printInputMetadata(type, options): string\n"})}),"\n",(0,r.jsx)(e.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(e.p,{children:["\u2022 ",(0,r.jsx)(e.strong,{children:"type"}),": ",(0,r.jsx)(e.code,{children:"unknown"})]}),"\n",(0,r.jsxs)(e.p,{children:["\u2022 ",(0,r.jsx)(e.strong,{children:"options"}),": ",(0,r.jsx)(e.code,{children:"PrintTypeOptions"})]}),"\n",(0,r.jsx)(e.h3,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(e.p,{children:(0,r.jsx)(e.code,{children:"string"})}),"\n",(0,r.jsx)(e.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(e.p,{children:(0,r.jsx)(e.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/graphql/input.ts#L5",children:"graphql/input.ts:5"})})]})}function o(n={}){const{wrapper:e}={...(0,i.R)(),...n.components};return e?(0,r.jsx)(e,{...n,children:(0,r.jsx)(c,{...n})}):c(n)}},28453:(n,e,t)=>{t.d(e,{R:()=>s,x:()=>l});var r=t(96540);const i={},a=r.createContext(i);function s(n){const e=r.useContext(a);return r.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function l(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:s(n.components),r.createElement(a.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/d565c98c.b10ed2f2.js b/assets/js/d565c98c.b10ed2f2.js new file mode 100644 index 000000000..d4e313ec3 --- /dev/null +++ b/assets/js/d565c98c.b10ed2f2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[5026],{65935:(e,n,t)=>{t.r(n),t.d(n,{Badge:()=>p,Bullet:()=>d,Details:()=>f,SpecifiedBy:()=>m,assets:()=>l,contentTitle:()=>a,default:()=>h,frontMatter:()=>i,metadata:()=>c,toc:()=>u});var o=t(74848),s=t(28453),r=t(96540);const i={id:"one-of",title:"oneOf"},a=void 0,c={id:"common/directives/one-of",title:"oneOf",description:"Indicates exactly one field must be supplied and this field must not be null.",source:"@site/examples/group-by/common/directives/one-of.mdx",sourceDirName:"common/directives",slug:"/common/directives/one-of",permalink:"/examples/group-by/common/directives/one-of",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{id:"one-of",title:"oneOf"},sidebar:"schemaSidebar",previous:{title:"noDoc",permalink:"/examples/group-by/common/directives/no-doc"},next:{title:"skip",permalink:"/examples/group-by/common/directives/skip"}},l={},d=()=>{const e={span:"span",...(0,s.R)()};return(0,o.jsx)(o.Fragment,{children:(0,o.jsx)(e.span,{style:{fontWeight:"normal",fontSize:".5em",color:"var(--ifm-color-secondary-darkest)"},children:"\xa0\u25cf\xa0"})})},m=e=>{const n={a:"a",...(0,s.R)()};return(0,o.jsxs)(o.Fragment,{children:["Specification",(0,o.jsx)(n.a,{className:"link",style:{fontSize:"1.5em",paddingLeft:"4px"},target:"_blank",href:e.url,title:"Specified by "+e.url,children:"\u2398"})]})},p=e=>{const n={span:"span",...(0,s.R)()};return(0,o.jsx)(o.Fragment,{children:(0,o.jsx)(n.span,{className:e.class,children:e.text})})},u=[],f=({dataOpen:e,dataClose:n,children:t,startOpen:i=!1})=>{const a={details:"details",summary:"summary",...(0,s.R)()},[c,l]=(0,r.useState)(i);return(0,o.jsxs)(a.details,{...c?{open:!0}:{},className:"details",style:{border:"none",boxShadow:"none",background:"var(--ifm-background-color)"},children:[(0,o.jsx)(a.summary,{onClick:e=>{e.preventDefault(),l((e=>!e))},style:{listStyle:"none"},children:c?e:n}),c&&t]})};function x(e){const n={code:"code",p:"p",pre:"pre",...(0,s.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(n.p,{children:["Indicates exactly one field must be supplied and this field must not be ",(0,o.jsx)(n.code,{children:"null"}),"."]}),"\n",(0,o.jsx)(n.pre,{children:(0,o.jsx)(n.code,{className:"language-graphql",children:"directive @oneOf on INPUT_OBJECT\n"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,o.jsx)(n,{...e,children:(0,o.jsx)(x,{...e})}):x(e)}},28453:(e,n,t)=>{t.d(n,{R:()=>i,x:()=>a});var o=t(96540);const s={},r=o.createContext(s);function i(e){const n=o.useContext(r);return o.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),o.createElement(r.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/d56b581c.0d7ebfbf.js b/assets/js/d56b581c.0d7ebfbf.js new file mode 100644 index 000000000..f5255a6ad --- /dev/null +++ b/assets/js/d56b581c.0d7ebfbf.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[9489],{15517:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>d,contentTitle:()=>s,default:()=>p,frontMatter:()=>a,metadata:()=>l,toc:()=>c});var t=r(74848),i=r(28453);const a={title:"enum",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},s=void 0,l={id:"printer-legacy/graphql/enum",title:"enum",description:"printCodeEnum()",source:"@site/api/printer-legacy/graphql/enum.md",sourceDirName:"printer-legacy/graphql",slug:"/printer-legacy/graphql/enum",permalink:"/api/printer-legacy/graphql/enum",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"enum",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},d={},c=[{value:"printCodeEnum()",id:"printcodeenum",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"printEnumMetadata()",id:"printenummetadata",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"printcodeenum",children:"printCodeEnum()"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function printCodeEnum(type, options?): string\n"})}),"\n",(0,t.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"type"}),": ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,t.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"string"})}),"\n",(0,t.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/graphql/enum.ts#L24",children:"graphql/enum.ts:24"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h2,{id:"printenummetadata",children:"printEnumMetadata()"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function printEnumMetadata(type, options): string | MDXString\n"})}),"\n",(0,t.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"type"}),": ",(0,t.jsx)(n.code,{children:"unknown"})]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options"}),": ",(0,t.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,t.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,t.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/graphql/enum.ts#L13",children:"graphql/enum.ts:13"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>l});var t=r(96540);const i={},a=t.createContext(i);function s(e){const n=t.useContext(a);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),t.createElement(a.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/da360fa0.dcc3b7f3.js b/assets/js/da360fa0.dcc3b7f3.js new file mode 100644 index 000000000..d8c93876b --- /dev/null +++ b/assets/js/da360fa0.dcc3b7f3.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[924],{97696:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>d,default:()=>o,frontMatter:()=>t,metadata:()=>l,toc:()=>c});var s=r(74848),i=r(28453);const t={title:"string",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},d=void 0,l={id:"utils/string",title:"string",description:"Library of helpers for formatting strings.",source:"@site/api/utils/string.md",sourceDirName:"utils",slug:"/utils/string",permalink:"/api/utils/string",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"string",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},a={},c=[{value:"capitalize()",id:"capitalize",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"escapeMDX()",id:"escapemdx",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3},{value:"firstUppercase()",id:"firstuppercase",level:2},{value:"Parameters",id:"parameters-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Defined in",id:"defined-in-2",level:3},{value:"kebabCase()",id:"kebabcase",level:2},{value:"Parameters",id:"parameters-3",level:3},{value:"Returns",id:"returns-3",level:3},{value:"Defined in",id:"defined-in-3",level:3},{value:"prune()",id:"prune",level:2},{value:"Parameters",id:"parameters-4",level:3},{value:"Returns",id:"returns-4",level:3},{value:"Defined in",id:"defined-in-4",level:3},{value:"replaceDiacritics()",id:"replacediacritics",level:2},{value:"Parameters",id:"parameters-5",level:3},{value:"Returns",id:"returns-5",level:3},{value:"Defined in",id:"defined-in-5",level:3},{value:"slugify()",id:"slugify",level:2},{value:"Parameters",id:"parameters-6",level:3},{value:"Returns",id:"returns-6",level:3},{value:"Example",id:"example",level:3},{value:"Defined in",id:"defined-in-6",level:3},{value:"startCase()",id:"startcase",level:2},{value:"Parameters",id:"parameters-7",level:3},{value:"Returns",id:"returns-7",level:3},{value:"Defined in",id:"defined-in-7",level:3},{value:"stringCaseBuilder()",id:"stringcasebuilder",level:2},{value:"Parameters",id:"parameters-8",level:3},{value:"Returns",id:"returns-8",level:3},{value:"Defined in",id:"defined-in-8",level:3},{value:"toHTMLUnicode()",id:"tohtmlunicode",level:2},{value:"Parameters",id:"parameters-9",level:3},{value:"Returns",id:"returns-9",level:3},{value:"Defined in",id:"defined-in-9",level:3}];function h(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.p,{children:"Library of helpers for formatting strings."}),"\n",(0,s.jsx)(n.h2,{id:"capitalize",children:"capitalize()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function capitalize(str): string\n"})}),"\n",(0,s.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"str"}),": ",(0,s.jsx)(n.code,{children:"Maybe"}),"<",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"the string to be transformed."}),"\n",(0,s.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsxs)(n.p,{children:["a capitalized string, or an empty string if ",(0,s.jsx)(n.code,{children:"str"})," is not a valid string."]}),"\n",(0,s.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/utils/src/string.ts#L224",children:"string.ts:224"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"escapemdx",children:"escapeMDX()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function escapeMDX(str): string\n"})}),"\n",(0,s.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"str"}),": ",(0,s.jsx)(n.code,{children:"unknown"})]}),"\n",(0,s.jsx)(n.p,{children:"the string to be transformed."}),"\n",(0,s.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsx)(n.p,{children:"a string with MDX special characters replaced by HTML unicode equivalents."}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/utils/src/string.ts#L177",children:"string.ts:177"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"firstuppercase",children:"firstUppercase()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function firstUppercase(str): string\n"})}),"\n",(0,s.jsx)(n.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"str"}),": ",(0,s.jsx)(n.code,{children:"Maybe"}),"<",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"the string to be transformed."}),"\n",(0,s.jsx)(n.h3,{id:"returns-2",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsxs)(n.p,{children:["a string with the 1st character in uppercase, or an empty string if ",(0,s.jsx)(n.code,{children:"str"})," is not a valid string."]}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/utils/src/string.ts#L200",children:"string.ts:200"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"kebabcase",children:"kebabCase()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function kebabCase(str): string\n"})}),"\n",(0,s.jsx)(n.h3,{id:"parameters-3",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"str"}),": ",(0,s.jsx)(n.code,{children:"Maybe"}),"<",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"the string to be transformed."}),"\n",(0,s.jsx)(n.h3,{id:"returns-3",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsxs)(n.p,{children:["a string converted to start case, or an empty string if ",(0,s.jsx)(n.code,{children:"str"})," is not a valid string."]}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/utils/src/string.ts#L267",children:"string.ts:267"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"prune",children:"prune()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function prune(str, substr): string\n"})}),"\n",(0,s.jsx)(n.h3,{id:"parameters-4",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"str"}),": ",(0,s.jsx)(n.code,{children:"Maybe"}),"<",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"the string to be pruned."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"substr"}),": ",(0,s.jsx)(n.code,{children:"string"})," = ",(0,s.jsx)(n.code,{children:'""'})]}),"\n",(0,s.jsxs)(n.p,{children:["the substring to be removed from ",(0,s.jsx)(n.code,{children:"str"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"returns-4",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsxs)(n.p,{children:["a pruned string, or an empty string if ",(0,s.jsx)(n.code,{children:"str"})," is not a valid string."]}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/utils/src/string.ts#L58",children:"string.ts:58"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"replacediacritics",children:"replaceDiacritics()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function replaceDiacritics(str): string\n"})}),"\n",(0,s.jsx)(n.h3,{id:"parameters-5",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"str"}),": ",(0,s.jsx)(n.code,{children:"Maybe"}),"<",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"the string to be transformed."}),"\n",(0,s.jsx)(n.h3,{id:"returns-5",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsxs)(n.p,{children:["a string with diacritic characters replaced, or an empty string if ",(0,s.jsx)(n.code,{children:"str"})," is not a valid string."]}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/utils/src/string.ts#L27",children:"string.ts:27"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"slugify",children:"slugify()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function slugify(str): string\n"})}),"\n",(0,s.jsxs)(n.p,{children:["Returns a lowercase string with ",(0,s.jsx)(n.code,{children:"-"})," as replacement for non alphanum characters using ",(0,s.jsx)(n.a,{href:"/api/utils/string#stringcasebuilder",children:"stringCaseBuilder"}),"."]}),"\n",(0,s.jsx)(n.h3,{id:"parameters-6",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"str"}),": ",(0,s.jsx)(n.code,{children:"Maybe"}),"<",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"the string to be transformed."}),"\n",(0,s.jsx)(n.h3,{id:"returns-6",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsxs)(n.p,{children:["a string converted to start case, or an empty string if ",(0,s.jsx)(n.code,{children:"str"})," is not a valid string."]}),"\n",(0,s.jsx)(n.h3,{id:"example",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-js",children:'import { kebabCase } from "@graphql-markdown/utils/string";\n\nkebabCase("The quick brown Fox");\n// Expected result: "the-quick-brown-fox"\n'})}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/utils/src/string.ts#L282",children:"string.ts:282"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"startcase",children:"startCase()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function startCase(str): string\n"})}),"\n",(0,s.jsx)(n.h3,{id:"parameters-7",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"str"}),": ",(0,s.jsx)(n.code,{children:"Maybe"}),"<",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"the string to be transformed."}),"\n",(0,s.jsx)(n.h3,{id:"returns-7",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsxs)(n.p,{children:["a string converted to start case, or an empty string if ",(0,s.jsx)(n.code,{children:"str"})," is not a valid string."]}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/utils/src/string.ts#L246",children:"string.ts:246"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"stringcasebuilder",children:"stringCaseBuilder()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function stringCaseBuilder(\n str, \n transformation?, \n separator?, \n splitter?): string\n"})}),"\n",(0,s.jsx)(n.h3,{id:"parameters-8",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"str"}),": ",(0,s.jsx)(n.code,{children:"Maybe"}),"<",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"the string to be transformed."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"transformation?"}),": ",(0,s.jsx)(n.code,{children:"Maybe"}),"<(",(0,s.jsx)(n.code,{children:"word"}),") => ",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"optional transformation callback function."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"separator?"}),": ",(0,s.jsx)(n.code,{children:"string"})]}),"\n",(0,s.jsx)(n.p,{children:"optional character separator for word-based transformation."}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"splitter?"}),": ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.code,{children:"RegExp"})," = ",(0,s.jsx)(n.code,{children:"..."})]}),"\n",(0,s.jsx)(n.p,{children:"optional regex or string rule for splitting string into word."}),"\n",(0,s.jsx)(n.h3,{id:"returns-8",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsxs)(n.p,{children:["a transformed string, or an empty string if ",(0,s.jsx)(n.code,{children:"str"})," is not a valid string."]}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/utils/src/string.ts#L100",children:"string.ts:100"})}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h2,{id:"tohtmlunicode",children:"toHTMLUnicode()"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"function toHTMLUnicode(char): string\n"})}),"\n",(0,s.jsx)(n.h3,{id:"parameters-9",children:"Parameters"}),"\n",(0,s.jsxs)(n.p,{children:["\u2022 ",(0,s.jsx)(n.strong,{children:"char"}),": ",(0,s.jsx)(n.code,{children:"Maybe"}),"<",(0,s.jsx)(n.code,{children:"string"}),">"]}),"\n",(0,s.jsx)(n.p,{children:"the character to be transformed."}),"\n",(0,s.jsx)(n.h3,{id:"returns-9",children:"Returns"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"string"})}),"\n",(0,s.jsxs)(n.p,{children:["a HTML unicode representation of ",(0,s.jsx)(n.code,{children:"char"}),", or an empty string if ",(0,s.jsx)(n.code,{children:"char"})," is not a valid string."]}),"\n",(0,s.jsx)(n.h3,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/utils/src/string.ts#L146",children:"string.ts:146"})})]})}function o(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>d,x:()=>l});var s=r(96540);const i={},t=s.createContext(i);function d(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e16884a3.79570acc.js b/assets/js/e16884a3.79570acc.js new file mode 100644 index 000000000..88fb8c61d --- /dev/null +++ b/assets/js/e16884a3.79570acc.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[5555],{81700:(e,i,r)=>{r.r(i),r.d(i,{assets:()=>a,contentTitle:()=>c,default:()=>o,frontMatter:()=>t,metadata:()=>d,toc:()=>l});var n=r(74848),s=r(28453);const t={title:"directive",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},c=void 0,d={id:"graphql/directive",title:"directive",description:"Library supporting customDirective for directive based customization.",source:"@site/api/graphql/directive.md",sourceDirName:"graphql",slug:"/graphql/directive",permalink:"/api/graphql/directive",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"directive",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},a={},l=[{value:"See",id:"see",level:2},{value:"WILDCARD_DIRECTIVE",id:"wildcard_directive",level:2},{value:"Defined in",id:"defined-in",level:3},{value:"executableDirectiveLocation()",id:"executabledirectivelocation",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in-1",level:3},{value:"getConstDirectiveMap()",id:"getconstdirectivemap",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-2",level:3},{value:"getCustomDirectiveOptions()",id:"getcustomdirectiveoptions",level:2},{value:"Parameters",id:"parameters-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Defined in",id:"defined-in-3",level:3},{value:"getCustomDirectives()",id:"getcustomdirectives",level:2},{value:"Parameters",id:"parameters-3",level:3},{value:"Returns",id:"returns-3",level:3},{value:"Defined in",id:"defined-in-4",level:3},{value:"isCustomDirective()",id:"iscustomdirective",level:2},{value:"Parameters",id:"parameters-4",level:3},{value:"Returns",id:"returns-4",level:3},{value:"Defined in",id:"defined-in-5",level:3},{value:"typeSystemDirectiveLocation()",id:"typesystemdirectivelocation",level:2},{value:"Parameters",id:"parameters-5",level:3},{value:"Returns",id:"returns-5",level:3},{value:"Defined in",id:"defined-in-6",level:3}];function h(e){const i={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,s.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(i.p,{children:["Library supporting ",(0,n.jsx)(i.code,{children:"customDirective"})," for directive based customization."]}),"\n",(0,n.jsx)(i.h2,{id:"see",children:"See"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsxs)(i.a,{href:"https://graphql-markdown.dev/docs/advanced/custom-directive",children:["Option ",(0,n.jsx)(i.code,{children:"customDirective"})]})}),"\n",(0,n.jsx)(i.h2,{id:"wildcard_directive",children:"WILDCARD_DIRECTIVE"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-ts",children:'const WILDCARD_DIRECTIVE: "*";\n'})}),"\n",(0,n.jsxs)(i.p,{children:["Wildcard ",(0,n.jsx)(i.code,{children:"*"})," character for matching any directive name."]}),"\n",(0,n.jsxs)(i.p,{children:["See ",(0,n.jsx)(i.a,{href:"/api/graphql/directive#getcustomdirectiveoptions",children:"getCustomDirectiveOptions"}),", ",(0,n.jsx)(i.a,{href:"/api/graphql/directive#iscustomdirective",children:"isCustomDirective"})]}),"\n",(0,n.jsx)(i.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/directive.ts#L30",children:"packages/graphql/src/directive.ts:30"})}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"executabledirectivelocation",children:"executableDirectiveLocation()"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-ts",children:"function executableDirectiveLocation(directive): boolean\n"})}),"\n",(0,n.jsx)(i.p,{children:"Checks if a directive is executable (related to operations)."}),"\n",(0,n.jsx)(i.h3,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"directive"}),": ",(0,n.jsx)(i.code,{children:"GraphQLDirective"})]}),"\n",(0,n.jsx)(i.h3,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"boolean"})}),"\n",(0,n.jsx)(i.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/directive.ts#L285",children:"packages/graphql/src/directive.ts:285"})}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"getconstdirectivemap",children:"getConstDirectiveMap()"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-ts",children:"function getConstDirectiveMap(entity, customDirectiveMap): Maybe\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"entity"}),": ",(0,n.jsx)(i.code,{children:"unknown"})]}),"\n",(0,n.jsx)(i.p,{children:"a GraphQL schema entity."}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"customDirectiveMap"}),": ",(0,n.jsx)(i.code,{children:"Maybe"}),"<",(0,n.jsx)(i.code,{children:"CustomDirectiveMap"}),">"]}),"\n",(0,n.jsxs)(i.p,{children:["a custom directive map (see ",(0,n.jsx)(i.a,{href:"/api/graphql/directive#getcustomdirectives",children:"getCustomDirectives"}),")."]}),"\n",(0,n.jsx)(i.h3,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.code,{children:"Maybe"}),"<",(0,n.jsx)(i.code,{children:"CustomDirectiveMap"}),">"]}),"\n",(0,n.jsxs)(i.p,{children:["a map of GraphQL directives matching the custom directives defined, else ",(0,n.jsx)(i.code,{children:"undefined"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"defined-in-2",children:"Defined in"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/directive.ts#L250",children:"packages/graphql/src/directive.ts:250"})}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"getcustomdirectiveoptions",children:"getCustomDirectiveOptions()"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-ts",children:"function getCustomDirectiveOptions(schemaDirectiveName, customDirectiveOptions): Maybe\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"schemaDirectiveName"}),": ",(0,n.jsx)(i.code,{children:"DirectiveName"})]}),"\n",(0,n.jsx)(i.p,{children:"the GraphQL directive name."}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"customDirectiveOptions"}),": ",(0,n.jsx)(i.code,{children:"CustomDirective"})]}),"\n",(0,n.jsxs)(i.p,{children:["the ",(0,n.jsx)(i.code,{children:"customDirective"})," option."]}),"\n",(0,n.jsx)(i.h3,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.code,{children:"Maybe"}),"<",(0,n.jsx)(i.code,{children:"CustomDirectiveOptions"}),">"]}),"\n",(0,n.jsxs)(i.p,{children:["a record set of custom handlers for the matching directive (or if ",(0,n.jsx)(i.code,{children:"*"})," is declared), or undefined if no match."]}),"\n",(0,n.jsx)(i.h3,{id:"defined-in-3",children:"Defined in"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/directive.ts#L78",children:"packages/graphql/src/directive.ts:78"})}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"getcustomdirectives",children:"getCustomDirectives()"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-ts",children:"function getCustomDirectives(schemaMap, customDirectiveOptions?): Maybe\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-3",children:"Parameters"}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"schemaMap"}),": ",(0,n.jsx)(i.code,{children:"Pick"}),"<",(0,n.jsx)(i.code,{children:"SchemaMap"}),", ",(0,n.jsx)(i.code,{children:'"directives"'}),">"]}),"\n",(0,n.jsxs)(i.p,{children:["the GraphQL schema map returned by ",(0,n.jsx)(i.a,{href:"/api/graphql/introspection#getschemamap",children:"introspection!getSchemaMap"})]}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"customDirectiveOptions?"}),": ",(0,n.jsx)(i.code,{children:"Maybe"}),"<",(0,n.jsx)(i.code,{children:"CustomDirective"}),">"]}),"\n",(0,n.jsxs)(i.p,{children:["the ",(0,n.jsx)(i.code,{children:"customDirective"})," option."]}),"\n",(0,n.jsx)(i.h3,{id:"returns-3",children:"Returns"}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.code,{children:"Maybe"}),"<",(0,n.jsx)(i.code,{children:"CustomDirectiveMap"}),">"]}),"\n",(0,n.jsx)(i.p,{children:"a custom directive map, or undefined if no match."}),"\n",(0,n.jsx)(i.h3,{id:"defined-in-4",children:"Defined in"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/directive.ts#L152",children:"packages/graphql/src/directive.ts:152"})}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"iscustomdirective",children:"isCustomDirective()"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-ts",children:"function isCustomDirective(schemaDirectiveName, customDirectiveOptions): boolean\n"})}),"\n",(0,n.jsx)(i.h3,{id:"parameters-4",children:"Parameters"}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"schemaDirectiveName"}),": ",(0,n.jsx)(i.code,{children:"DirectiveName"})]}),"\n",(0,n.jsx)(i.p,{children:"the GraphQL directive name."}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"customDirectiveOptions"}),": ",(0,n.jsx)(i.code,{children:"CustomDirective"})]}),"\n",(0,n.jsxs)(i.p,{children:["the ",(0,n.jsx)(i.code,{children:"customDirective"})," option."]}),"\n",(0,n.jsx)(i.h3,{id:"returns-4",children:"Returns"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"boolean"})}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.code,{children:"true"})," if the directive is declared or ",(0,n.jsx)(i.code,{children:"*"})," is declared in ",(0,n.jsx)(i.code,{children:"customDirective"})," option, else ",(0,n.jsx)(i.code,{children:"false"}),"."]}),"\n",(0,n.jsx)(i.h3,{id:"defined-in-5",children:"Defined in"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/directive.ts#L41",children:"packages/graphql/src/directive.ts:41"})}),"\n",(0,n.jsx)(i.hr,{}),"\n",(0,n.jsx)(i.h2,{id:"typesystemdirectivelocation",children:"typeSystemDirectiveLocation()"}),"\n",(0,n.jsx)(i.pre,{children:(0,n.jsx)(i.code,{className:"language-ts",children:"function typeSystemDirectiveLocation(directive): boolean\n"})}),"\n",(0,n.jsx)(i.p,{children:"Checks if a directive is system (related to schema definition)."}),"\n",(0,n.jsx)(i.h3,{id:"parameters-5",children:"Parameters"}),"\n",(0,n.jsxs)(i.p,{children:["\u2022 ",(0,n.jsx)(i.strong,{children:"directive"}),": ",(0,n.jsx)(i.code,{children:"GraphQLDirective"})]}),"\n",(0,n.jsx)(i.h3,{id:"returns-5",children:"Returns"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.code,{children:"boolean"})}),"\n",(0,n.jsx)(i.h3,{id:"defined-in-6",children:"Defined in"}),"\n",(0,n.jsx)(i.p,{children:(0,n.jsx)(i.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/directive.ts#L308",children:"packages/graphql/src/directive.ts:308"})})]})}function o(e={}){const{wrapper:i}={...(0,s.R)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},28453:(e,i,r)=>{r.d(i,{R:()=>c,x:()=>d});var n=r(96540);const s={},t=n.createContext(s);function c(e){const i=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function d(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),n.createElement(t.Provider,{value:i},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e3e63689.8c137ef7.js b/assets/js/e3e63689.8c137ef7.js new file mode 100644 index 000000000..02b4985a2 --- /dev/null +++ b/assets/js/e3e63689.8c137ef7.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[6800],{84628:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>o,frontMatter:()=>t,metadata:()=>l,toc:()=>d});var a=r(74848),i=r(28453);const t={title:"scalar",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},s=void 0,l={id:"printer-legacy/graphql/scalar",title:"scalar",description:"printCodeScalar()",source:"@site/api/printer-legacy/graphql/scalar.md",sourceDirName:"printer-legacy/graphql",slug:"/printer-legacy/graphql/scalar",permalink:"/api/printer-legacy/graphql/scalar",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"scalar",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},c={},d=[{value:"printCodeScalar()",id:"printcodescalar",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"printScalarMetadata()",id:"printscalarmetadata",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3},{value:"printSpecification()",id:"printspecification",level:2},{value:"Parameters",id:"parameters-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Defined in",id:"defined-in-2",level:3}];function p(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h2,{id:"printcodescalar",children:"printCodeScalar()"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"function printCodeScalar(type, options?): string\n"})}),"\n",(0,a.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"type"}),": ",(0,a.jsx)(n.code,{children:"unknown"})]}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"options?"}),": ",(0,a.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,a.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.code,{children:"string"})}),"\n",(0,a.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/graphql/scalar.ts#L31",children:"graphql/scalar.ts:31"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h2,{id:"printscalarmetadata",children:"printScalarMetadata()"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"function printScalarMetadata(type, options?): string | MDXString\n"})}),"\n",(0,a.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"type"}),": ",(0,a.jsx)(n.code,{children:"unknown"})]}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"options?"}),": ",(0,a.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,a.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"string"})," | ",(0,a.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,a.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/graphql/scalar.ts#L24",children:"graphql/scalar.ts:24"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h2,{id:"printspecification",children:"printSpecification()"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"function printSpecification(type): string | MDXString\n"})}),"\n",(0,a.jsx)(n.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"type"}),": ",(0,a.jsx)(n.code,{children:"unknown"})]}),"\n",(0,a.jsx)(n.h3,{id:"returns-2",children:"Returns"}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"string"})," | ",(0,a.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,a.jsx)(n.h3,{id:"defined-in-2",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/graphql/scalar.ts#L8",children:"graphql/scalar.ts:8"})})]})}function o(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(p,{...e})}):p(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>l});var a=r(96540);const i={},t=a.createContext(i);function s(e){const n=a.useContext(t);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),a.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e47ee25b.437323b2.js b/assets/js/e47ee25b.437323b2.js new file mode 100644 index 000000000..1ae7829d8 --- /dev/null +++ b/assets/js/e47ee25b.437323b2.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[3160],{71342:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>d,metadata:()=>o,toc:()=>l});var a=r(74848),s=r(28453);const d={title:"loader",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},i=void 0,o={id:"graphql/loader",title:"loader",description:"Library for GraphQL schema loading and loaders config processing.",source:"@site/api/graphql/loader.md",sourceDirName:"graphql",slug:"/graphql/loader",permalink:"/api/graphql/loader",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"loader",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},c={},l=[{value:"getDocumentLoaders()",id:"getdocumentloaders",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"loadSchema()",id:"loadschema",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3}];function t(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,s.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(n.p,{children:["Library for GraphQL schema loading and ",(0,a.jsx)(n.code,{children:"loaders"})," config processing."]}),"\n",(0,a.jsx)(n.h2,{id:"getdocumentloaders",children:"getDocumentLoaders()"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"function getDocumentLoaders(loadersList): Promise>\n"})}),"\n",(0,a.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"loadersList"}),": ",(0,a.jsx)(n.code,{children:"Maybe"}),"<",(0,a.jsx)(n.code,{children:"LoaderOption"}),">"]}),"\n",(0,a.jsx)(n.p,{children:"the list of loaders defined in the plugin config."}),"\n",(0,a.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"Promise"}),"<",(0,a.jsx)(n.code,{children:"Maybe"}),"<",(0,a.jsx)(n.code,{children:"LoadSchemaOptions"}),">>"]}),"\n",(0,a.jsx)(n.p,{children:"a list of loader objects."}),"\n",(0,a.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/loader.ts#L106",children:"packages/graphql/src/loader.ts:106"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h2,{id:"loadschema",children:"loadSchema()"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"function loadSchema(schemaLocation, options): Promise\n"})}),"\n",(0,a.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"schemaLocation"}),": ",(0,a.jsx)(n.code,{children:"string"})]}),"\n",(0,a.jsx)(n.p,{children:"the schema location pointer matching the loader."}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"options"}),": ",(0,a.jsx)(n.code,{children:"BuildSchemaOptions"})," & ",(0,a.jsx)(n.code,{children:"GraphQLParseOptions"})," & ",(0,a.jsx)(n.code,{children:"object"})," & ",(0,a.jsx)(n.code,{children:"object"})," & ",(0,a.jsx)(n.code,{children:"object"})," & ",(0,a.jsx)(n.code,{children:"Partial"}),"<",(0,a.jsx)(n.code,{children:"IExecutableSchemaDefinition"}),"<",(0,a.jsx)(n.code,{children:"any"}),">> & ",(0,a.jsx)(n.code,{children:"object"})," & ",(0,a.jsx)(n.code,{children:"object"})]}),"\n",(0,a.jsxs)(n.p,{children:["the schema ",(0,a.jsx)(n.code,{children:"loaders"}),", and optional ",(0,a.jsx)(n.code,{children:"rootTypes"})," override."]}),"\n",(0,a.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"Promise"}),"<",(0,a.jsx)(n.code,{children:"GraphQLSchema"}),">"]}),"\n",(0,a.jsx)(n.p,{children:"a GraphQL schema."}),"\n",(0,a.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/loader.ts#L41",children:"packages/graphql/src/loader.ts:41"})})]})}function h(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(t,{...e})}):t(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>o});var a=r(96540);const s={},d=a.createContext(s);function i(e){const n=a.useContext(d);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),a.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e7f041fd.95f9134e.js b/assets/js/e7f041fd.95f9134e.js new file mode 100644 index 000000000..167f705c8 --- /dev/null +++ b/assets/js/e7f041fd.95f9134e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[7746],{89010:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>s,metadata:()=>u,toc:()=>d});var a=t(74848),r=t(28453),l=t(49489),o=t(7227);const s={id:"schema",slug:"/",title:"Schema Documentation",sidebar_position:1,hide_table_of_contents:!0,pagination_next:null,pagination_prev:null,sidebar_class_name:"navbar__toggle"},i=void 0,u={id:"schema",title:"Schema Documentation",description:"This documentation has been automatically generated using AniList APIv2 endpoint with following plugin configuration:",source:"@site/examples/default/anilist.md",sourceDirName:".",slug:"/",permalink:"/examples/default/",draft:!1,unlisted:!1,tags:[],version:"current",sidebarPosition:1,frontMatter:{id:"schema",slug:"/",title:"Schema Documentation",sidebar_position:1,hide_table_of_contents:!0,pagination_next:null,pagination_prev:null,sidebar_class_name:"navbar__toggle"},sidebar:"schemaSidebar"},c={},d=[];function p(e){const n={a:"a",code:"code",p:"p",pre:"pre",...(0,r.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(n.p,{children:["This documentation has been automatically generated using ",(0,a.jsx)(n.a,{href:"https://anilist.gitbook.io/anilist-apiv2-docs/",children:"AniList APIv2"})," endpoint with following plugin configuration:"]}),"\n",(0,a.jsxs)(l.A,{groupId:"config",children:[(0,a.jsx)(o.A,{value:"docusaurus",label:"Docusaurus (JSON)",children:(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-json",children:'{\n "schema": "https://graphql.anilist.co/",\n "linkRoot": "/examples/default",\n "baseURL": ".",\n "homepage": "data/anilist.md",\n "loaders": {\n "UrlLoader": {\n "module": "@graphql-tools/url-loader",\n "options": { "method": "POST" }\n }\n },\n "docOptions": {\n "frontMatter": {\n "pagination_next": null,\n "pagination_prev": null\n }\n },\n "printTypeOptions": {\n "deprecated": "group"\n }\n}\n'})})}),(0,a.jsx)(o.A,{value:"graphql-config",label:"GraphQL Config (YAML)",children:(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-yaml",children:'schema: https://graphql.anilist.co/\nextensions:\n graphql-markdown:\n linkRoot: "/examples/default"\n baseURL: "."\n homepage: data/anilist.md\n loaders:\n UrlLoader:\n module: "@graphql-tools/url-loader"\n options:\n method: POST\n docOptions:\n frontMatter:\n pagination_next: null\n pagination_prev: null\n printTypeOptions:\n deprecated: group\n'})})}),(0,a.jsx)(o.A,{value:"cli",label:"CLI",children:(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-bash",children:"npx docusaurus graphql-to-doc \\\n --homepage data/anilist.md \\\n --schema https://graphql.anilist.co/ \\\n --base . \\\n --link /examples/default \\\n --deprecated group\n"})})})]}),"\n",(0,a.jsx)("small",{children:(0,a.jsx)("i",{children:"Generated on 6/23/2024, 11:11:39 AM."})})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(p,{...e})}):p(e)}},7227:(e,n,t)=>{t.d(n,{A:()=>o});t(96540);var a=t(18215);const r={tabItem:"tabItem_Ymn6"};var l=t(74848);function o(e){let{children:n,hidden:t,className:o}=e;return(0,l.jsx)("div",{role:"tabpanel",className:(0,a.A)(r.tabItem,o),hidden:t,children:n})}},49489:(e,n,t)=>{t.d(n,{A:()=>y});var a=t(96540),r=t(18215),l=t(24245),o=t(56347),s=t(36494),i=t(62814),u=t(45167),c=t(81269);function d(e){return a.Children.toArray(e).filter((e=>"\n"!==e)).map((e=>{if(!e||(0,a.isValidElement)(e)&&function(e){const{props:n}=e;return!!n&&"object"==typeof n&&"value"in n}(e))return e;throw new Error(`Docusaurus error: Bad child <${"string"==typeof e.type?e.type:e.type.name}>: all children of the component should be , and every should have a unique "value" prop.`)}))?.filter(Boolean)??[]}function p(e){const{values:n,children:t}=e;return(0,a.useMemo)((()=>{const e=n??function(e){return d(e).map((e=>{let{props:{value:n,label:t,attributes:a,default:r}}=e;return{value:n,label:t,attributes:a,default:r}}))}(t);return function(e){const n=(0,u.X)(e,((e,n)=>e.value===n.value));if(n.length>0)throw new Error(`Docusaurus error: Duplicate values "${n.map((e=>e.value)).join(", ")}" found in . Every value needs to be unique.`)}(e),e}),[n,t])}function h(e){let{value:n,tabValues:t}=e;return t.some((e=>e.value===n))}function m(e){let{queryString:n=!1,groupId:t}=e;const r=(0,o.W6)(),l=function(e){let{queryString:n=!1,groupId:t}=e;if("string"==typeof n)return n;if(!1===n)return null;if(!0===n&&!t)throw new Error('Docusaurus error: The component groupId prop is required if queryString=true, because this value is used as the search param name. You can also provide an explicit value such as queryString="my-search-param".');return t??null}({queryString:n,groupId:t});return[(0,i.aZ)(l),(0,a.useCallback)((e=>{if(!l)return;const n=new URLSearchParams(r.location.search);n.set(l,e),r.replace({...r.location,search:n.toString()})}),[l,r])]}function f(e){const{defaultValue:n,queryString:t=!1,groupId:r}=e,l=p(e),[o,i]=(0,a.useState)((()=>function(e){let{defaultValue:n,tabValues:t}=e;if(0===t.length)throw new Error("Docusaurus error: the component requires at least one children component");if(n){if(!h({value:n,tabValues:t}))throw new Error(`Docusaurus error: The has a defaultValue "${n}" but none of its children has the corresponding value. Available values are: ${t.map((e=>e.value)).join(", ")}. If you intend to show no default tab, use defaultValue={null} instead.`);return n}const a=t.find((e=>e.default))??t[0];if(!a)throw new Error("Unexpected error: 0 tabValues");return a.value}({defaultValue:n,tabValues:l}))),[u,d]=m({queryString:t,groupId:r}),[f,b]=function(e){let{groupId:n}=e;const t=function(e){return e?`docusaurus.tab.${e}`:null}(n),[r,l]=(0,c.Dv)(t);return[r,(0,a.useCallback)((e=>{t&&l.set(e)}),[t,l])]}({groupId:r}),g=(()=>{const e=u??f;return h({value:e,tabValues:l})?e:null})();(0,s.A)((()=>{g&&i(g)}),[g]);return{selectedValue:o,selectValue:(0,a.useCallback)((e=>{if(!h({value:e,tabValues:l}))throw new Error(`Can't select invalid tab value=${e}`);i(e),d(e),b(e)}),[d,b,l]),tabValues:l}}var b=t(11062);const g={tabList:"tabList__CuJ",tabItem:"tabItem_LNqP"};var v=t(74848);function x(e){let{className:n,block:t,selectedValue:a,selectValue:o,tabValues:s}=e;const i=[],{blockElementScrollPositionUntilNextRender:u}=(0,l.a_)(),c=e=>{const n=e.currentTarget,t=i.indexOf(n),r=s[t].value;r!==a&&(u(n),o(r))},d=e=>{let n=null;switch(e.key){case"Enter":c(e);break;case"ArrowRight":{const t=i.indexOf(e.currentTarget)+1;n=i[t]??i[0];break}case"ArrowLeft":{const t=i.indexOf(e.currentTarget)-1;n=i[t]??i[i.length-1];break}}n?.focus()};return(0,v.jsx)("ul",{role:"tablist","aria-orientation":"horizontal",className:(0,r.A)("tabs",{"tabs--block":t},n),children:s.map((e=>{let{value:n,label:t,attributes:l}=e;return(0,v.jsx)("li",{role:"tab",tabIndex:a===n?0:-1,"aria-selected":a===n,ref:e=>i.push(e),onKeyDown:d,onClick:c,...l,className:(0,r.A)("tabs__item",g.tabItem,l?.className,{"tabs__item--active":a===n}),children:t??n},n)}))})}function _(e){let{lazy:n,children:t,selectedValue:r}=e;const l=(Array.isArray(t)?t:[t]).filter(Boolean);if(n){const e=l.find((e=>e.props.value===r));return e?(0,a.cloneElement)(e,{className:"margin-top--md"}):null}return(0,v.jsx)("div",{className:"margin-top--md",children:l.map(((e,n)=>(0,a.cloneElement)(e,{key:n,hidden:e.props.value!==r})))})}function w(e){const n=f(e);return(0,v.jsxs)("div",{className:(0,r.A)("tabs-container",g.tabList),children:[(0,v.jsx)(x,{...e,...n}),(0,v.jsx)(_,{...e,...n})]})}function y(e){const n=(0,b.A)();return(0,v.jsx)(w,{...e,children:d(e.children)},String(n))}},28453:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>s});var a=t(96540);const r={},l=a.createContext(r);function o(e){const n=a.useContext(l);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),a.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/e9540e45.39044c82.js b/assets/js/e9540e45.39044c82.js new file mode 100644 index 000000000..9391781d4 --- /dev/null +++ b/assets/js/e9540e45.39044c82.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[7514],{71001:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>s,default:()=>o,frontMatter:()=>t,metadata:()=>l,toc:()=>d});var a=r(74848),i=r(28453);const t={title:"relation",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},s=void 0,l={id:"graphql/relation",title:"relation",description:"Library supporting relatedTypeSection for displaying relations between GraphQL schema entities.",source:"@site/api/graphql/relation.md",sourceDirName:"graphql",slug:"/graphql/relation",permalink:"/api/graphql/relation",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"relation",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},c={},d=[{value:"See",id:"see",level:2},{value:"getRelationOfField()",id:"getrelationoffield",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3},{value:"getRelationOfImplementation()",id:"getrelationofimplementation",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-1",level:3},{value:"getRelationOfInterface()",id:"getrelationofinterface",level:2},{value:"Parameters",id:"parameters-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Defined in",id:"defined-in-2",level:3},{value:"getRelationOfReturn()",id:"getrelationofreturn",level:2},{value:"Parameters",id:"parameters-3",level:3},{value:"Returns",id:"returns-3",level:3},{value:"Defined in",id:"defined-in-3",level:3},{value:"getRelationOfUnion()",id:"getrelationofunion",level:2},{value:"Parameters",id:"parameters-4",level:3},{value:"Returns",id:"returns-4",level:3},{value:"Defined in",id:"defined-in-4",level:3}];function h(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsxs)(n.p,{children:["Library supporting ",(0,a.jsx)(n.code,{children:"relatedTypeSection"})," for displaying relations between GraphQL schema entities."]}),"\n",(0,a.jsx)(n.h2,{id:"see",children:"See"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsxs)(n.a,{href:"https://graphql-markdown.dev/docs/settings#printtypeoptions",children:["Option ",(0,a.jsx)(n.code,{children:"relatedTypeSection"})]})}),"\n",(0,a.jsx)(n.h2,{id:"getrelationoffield",children:"getRelationOfField()"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"function getRelationOfField(type, schemaMap): Partial>\n"})}),"\n",(0,a.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"type"}),": ",(0,a.jsx)(n.code,{children:"unknown"})]}),"\n",(0,a.jsx)(n.p,{children:"the GraphQL schema type being processed."}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"schemaMap"}),": ",(0,a.jsx)(n.code,{children:"Maybe"}),"<",(0,a.jsx)(n.code,{children:"SchemaMap"}),">"]}),"\n",(0,a.jsxs)(n.p,{children:["a GraphQL schema map (see ",(0,a.jsx)(n.a,{href:"/api/graphql/introspection#getschemamap",children:"introspection!getSchemaMap"}),")."]}),"\n",(0,a.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"Partial"}),"<",(0,a.jsx)(n.code,{children:"Record"}),"<",(0,a.jsx)(n.code,{children:"SchemaEntity"}),", ",(0,a.jsx)(n.code,{children:"RelationOfField"}),"[]>>"]}),"\n",(0,a.jsx)(n.p,{children:"a record map of fields and arguments relations."}),"\n",(0,a.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/relation.ts#L165",children:"packages/graphql/src/relation.ts:165"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h2,{id:"getrelationofimplementation",children:"getRelationOfImplementation()"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"function getRelationOfImplementation(type, schemaMap): Partial>\n"})}),"\n",(0,a.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"type"}),": ",(0,a.jsx)(n.code,{children:"unknown"})]}),"\n",(0,a.jsx)(n.p,{children:"the GraphQL schema type being processed."}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"schemaMap"}),": ",(0,a.jsx)(n.code,{children:"Maybe"}),"<",(0,a.jsx)(n.code,{children:"SchemaMap"}),">"]}),"\n",(0,a.jsxs)(n.p,{children:["a GraphQL schema map (see ",(0,a.jsx)(n.a,{href:"/api/graphql/introspection#getschemamap",children:"introspection!getSchemaMap"}),")."]}),"\n",(0,a.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"Partial"}),"<",(0,a.jsx)(n.code,{children:"Record"}),"<",(0,a.jsx)(n.code,{children:"SchemaEntity"}),", ",(0,a.jsx)(n.code,{children:"RelationOfImplementation"}),"[]>>"]}),"\n",(0,a.jsx)(n.p,{children:"a record map of unions or interfaces relations."}),"\n",(0,a.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/relation.ts#L351",children:"packages/graphql/src/relation.ts:351"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h2,{id:"getrelationofinterface",children:"getRelationOfInterface()"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"function getRelationOfInterface(type, schemaMap): Partial>\n"})}),"\n",(0,a.jsx)(n.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"type"}),": ",(0,a.jsx)(n.code,{children:"unknown"})]}),"\n",(0,a.jsx)(n.p,{children:"the GraphQL schema type being processed."}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"schemaMap"}),": ",(0,a.jsx)(n.code,{children:"Maybe"}),"<",(0,a.jsx)(n.code,{children:"SchemaMap"}),">"]}),"\n",(0,a.jsxs)(n.p,{children:["a GraphQL schema map (see ",(0,a.jsx)(n.a,{href:"/api/graphql/introspection#getschemamap",children:"introspection!getSchemaMap"}),")."]}),"\n",(0,a.jsx)(n.h3,{id:"returns-2",children:"Returns"}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"Partial"}),"<",(0,a.jsx)(n.code,{children:"Record"}),"<",(0,a.jsx)(n.code,{children:"SchemaEntity"}),", ",(0,a.jsx)(n.code,{children:"RelationOfInterface"}),"[]>>"]}),"\n",(0,a.jsx)(n.p,{children:"a record map of interfaces relations."}),"\n",(0,a.jsx)(n.h3,{id:"defined-in-2",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/relation.ts#L294",children:"packages/graphql/src/relation.ts:294"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h2,{id:"getrelationofreturn",children:"getRelationOfReturn()"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"function getRelationOfReturn(type, schemaMap): Partial>\n"})}),"\n",(0,a.jsx)(n.h3,{id:"parameters-3",children:"Parameters"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"type"}),": ",(0,a.jsx)(n.code,{children:"unknown"})]}),"\n",(0,a.jsx)(n.p,{children:"the GraphQL schema type being processed."}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"schemaMap"}),": ",(0,a.jsx)(n.code,{children:"Maybe"}),"<",(0,a.jsx)(n.code,{children:"SchemaMap"}),">"]}),"\n",(0,a.jsxs)(n.p,{children:["a GraphQL schema map (see ",(0,a.jsx)(n.a,{href:"/api/graphql/introspection#getschemamap",children:"introspection!getSchemaMap"}),")."]}),"\n",(0,a.jsx)(n.h3,{id:"returns-3",children:"Returns"}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"Partial"}),"<",(0,a.jsx)(n.code,{children:"Record"}),"<",(0,a.jsx)(n.code,{children:"SchemaEntity"}),", ",(0,a.jsx)(n.code,{children:"GraphQLOperationType"}),"[]>>"]}),"\n",(0,a.jsx)(n.p,{children:"a record map of operations relations."}),"\n",(0,a.jsx)(n.h3,{id:"defined-in-3",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/relation.ts#L104",children:"packages/graphql/src/relation.ts:104"})}),"\n",(0,a.jsx)(n.hr,{}),"\n",(0,a.jsx)(n.h2,{id:"getrelationofunion",children:"getRelationOfUnion()"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-ts",children:"function getRelationOfUnion(type, schemaMap): Partial>\n"})}),"\n",(0,a.jsx)(n.h3,{id:"parameters-4",children:"Parameters"}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"type"}),": ",(0,a.jsx)(n.code,{children:"unknown"})]}),"\n",(0,a.jsx)(n.p,{children:"the GraphQL schema type being processed."}),"\n",(0,a.jsxs)(n.p,{children:["\u2022 ",(0,a.jsx)(n.strong,{children:"schemaMap"}),": ",(0,a.jsx)(n.code,{children:"Maybe"}),"<",(0,a.jsx)(n.code,{children:"SchemaMap"}),">"]}),"\n",(0,a.jsxs)(n.p,{children:["a GraphQL schema map (see ",(0,a.jsx)(n.a,{href:"/api/graphql/introspection#getschemamap",children:"introspection!getSchemaMap"}),")."]}),"\n",(0,a.jsx)(n.h3,{id:"returns-4",children:"Returns"}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"Partial"}),"<",(0,a.jsx)(n.code,{children:"Record"}),"<",(0,a.jsx)(n.code,{children:"SchemaEntity"}),", ",(0,a.jsx)(n.code,{children:"GraphQLUnionType"}),"[]>>"]}),"\n",(0,a.jsx)(n.p,{children:"a record map of unions relations."}),"\n",(0,a.jsx)(n.h3,{id:"defined-in-4",children:"Defined in"}),"\n",(0,a.jsx)(n.p,{children:(0,a.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/graphql/src/relation.ts#L238",children:"packages/graphql/src/relation.ts:238"})})]})}function o(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(h,{...e})}):h(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>l});var a=r(96540);const i={},t=a.createContext(i);function s(e){const n=a.useContext(t);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:s(e.components),a.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/eb4a6c9f.93c9db3c.js b/assets/js/eb4a6c9f.93c9db3c.js new file mode 100644 index 000000000..83cf654a2 --- /dev/null +++ b/assets/js/eb4a6c9f.93c9db3c.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[5531],{80519:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>o,frontMatter:()=>s,metadata:()=>t,toc:()=>c});var i=r(74848),d=r(28453);const s={title:"badge",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},a=void 0,t={id:"printer-legacy/badge",title:"badge",description:"DEFAULT\\CSS\\CLASSNAME",source:"@site/api/printer-legacy/badge.md",sourceDirName:"printer-legacy",slug:"/printer-legacy/badge",permalink:"/api/printer-legacy/badge",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"badge",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},l={},c=[{value:"DEFAULT_CSS_CLASSNAME",id:"default_css_classname",level:2},{value:"Defined in",id:"defined-in",level:3},{value:"getTypeBadges()",id:"gettypebadges",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in-1",level:3},{value:"printBadge()",id:"printbadge",level:2},{value:"Parameters",id:"parameters-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Defined in",id:"defined-in-2",level:3},{value:"printBadges()",id:"printbadges",level:2},{value:"Parameters",id:"parameters-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Defined in",id:"defined-in-3",level:3}];function h(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,d.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h2,{id:"default_css_classname",children:"DEFAULT_CSS_CLASSNAME"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:'const DEFAULT_CSS_CLASSNAME: "badge--secondary";\n'})}),"\n",(0,i.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/badge.ts#L23",children:"badge.ts:23"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"gettypebadges",children:"getTypeBadges()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function getTypeBadges(type, groups?): Badge[]\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"groups?"}),": ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"Partial"}),"<",(0,i.jsx)(n.code,{children:"Record"}),"<",(0,i.jsx)(n.code,{children:"SchemaEntity"}),", ",(0,i.jsx)(n.code,{children:"Record"}),"<",(0,i.jsx)(n.code,{children:"string"}),", ",(0,i.jsx)(n.code,{children:"Maybe"}),"<",(0,i.jsx)(n.code,{children:"string"}),">>>>>"]}),"\n",(0,i.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"Badge"}),"[]"]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/badge.ts#L25",children:"badge.ts:25"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"printbadge",children:"printBadge()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printBadge(__namedParameters): MDXString\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"__namedParameters"}),": ",(0,i.jsx)(n.code,{children:"Badge"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.code,{children:"MDXString"})}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/badge.ts#L73",children:"badge.ts:73"})}),"\n",(0,i.jsx)(n.hr,{}),"\n",(0,i.jsx)(n.h2,{id:"printbadges",children:"printBadges()"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-ts",children:"function printBadges(type, options): string | MDXString\n"})}),"\n",(0,i.jsx)(n.h3,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"type"}),": ",(0,i.jsx)(n.code,{children:"unknown"})]}),"\n",(0,i.jsxs)(n.p,{children:["\u2022 ",(0,i.jsx)(n.strong,{children:"options"}),": ",(0,i.jsx)(n.code,{children:"PrintTypeOptions"})]}),"\n",(0,i.jsx)(n.h3,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"string"})," | ",(0,i.jsx)(n.code,{children:"MDXString"})]}),"\n",(0,i.jsx)(n.h3,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(n.p,{children:(0,i.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/printer-legacy/src/badge.ts#L79",children:"badge.ts:79"})})]})}function o(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>a,x:()=>t});var i=r(96540);const d={},s=i.createContext(d);function a(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function t(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:a(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/edc43b20.8d6cc523.js b/assets/js/edc43b20.8d6cc523.js new file mode 100644 index 000000000..8bba9a90f --- /dev/null +++ b/assets/js/edc43b20.8d6cc523.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[4084],{16286:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>m,frontMatter:()=>o,metadata:()=>s,toc:()=>d});var t=r(74848),a=r(28453);const o={title:"generator",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},i=void 0,s={id:"core/generator",title:"generator",description:"generateDocFromSchema()",source:"@site/api/core/generator.md",sourceDirName:"core",slug:"/core/generator",permalink:"/api/core/generator",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"generator",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},c={},d=[{value:"generateDocFromSchema()",id:"generatedocfromschema",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3}];function l(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,a.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"generatedocfromschema",children:"generateDocFromSchema()"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function generateDocFromSchema(__namedParameters): Promise\n"})}),"\n",(0,t.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"__namedParameters"}),": ",(0,t.jsx)(n.code,{children:"GeneratorOptions"})]}),"\n",(0,t.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.code,{children:"void"}),">"]}),"\n",(0,t.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/generator.ts#L28",children:"generator.ts:28"})})]})}function m(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>i,x:()=>s});var t=r(96540);const a={},o=t.createContext(a);function i(e){const n=t.useContext(o);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:i(e.components),t.createElement(o.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f6e8bb3b.8c0ea89b.js b/assets/js/f6e8bb3b.8c0ea89b.js new file mode 100644 index 000000000..3309e809c --- /dev/null +++ b/assets/js/f6e8bb3b.8c0ea89b.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[71],{68515:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>p,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var t=r(74848),i=r(28453);const s={title:"printer",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},o=void 0,c={id:"core/printer",title:"printer",description:"getPrinter()",source:"@site/api/core/printer.md",sourceDirName:"core",slug:"/core/printer",permalink:"/api/core/printer",draft:!1,unlisted:!1,tags:[],version:"current",frontMatter:{title:"printer",pagination_prev:null,pagination_next:null,toc_max_heading_level:2},sidebar:"defaultSidebar"},a={},d=[{value:"getPrinter()",id:"getprinter",level:2},{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Defined in",id:"defined-in",level:3}];function l(e){const n={a:"a",code:"code",em:"em",h2:"h2",h3:"h3",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.h2,{id:"getprinter",children:"getPrinter()"}),"\n",(0,t.jsx)(n.pre,{children:(0,t.jsx)(n.code,{className:"language-ts",children:"function getPrinter(\n printerModule?, \n config?, \noptions?): Promise\n"})}),"\n",(0,t.jsx)(n.h3,{id:"parameters",children:"Parameters"}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"printerModule?"}),": ",(0,t.jsx)(n.code,{children:"Maybe"}),"<",(0,t.jsx)(n.code,{children:"PackageName"}),">"]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"config?"}),": ",(0,t.jsx)(n.code,{children:"Maybe"}),"<",(0,t.jsx)(n.code,{children:"PrinterConfig"}),">"]}),"\n",(0,t.jsxs)(n.p,{children:["\u2022 ",(0,t.jsx)(n.strong,{children:"options?"}),": ",(0,t.jsx)(n.code,{children:"Maybe"}),"<",(0,t.jsx)(n.code,{children:"PrinterOptions"}),">"]}),"\n",(0,t.jsx)(n.h3,{id:"returns",children:"Returns"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"Promise"}),"<",(0,t.jsx)(n.em,{children:"typeof"})," ",(0,t.jsx)(n.code,{children:"IPrinter"}),">"]}),"\n",(0,t.jsx)(n.h3,{id:"defined-in",children:"Defined in"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.a,{href:"https://github.com/graphql-markdown/graphql-markdown/blob/main/packages/core/src/printer.ts#L10",children:"printer.ts:10"})})]})}function p(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(l,{...e})}):l(e)}},28453:(e,n,r)=>{r.d(n,{R:()=>o,x:()=>c});var t=r(96540);const i={},s=t.createContext(i);function o(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/main.89d2e621.js b/assets/js/main.89d2e621.js new file mode 100644 index 000000000..b5ae12578 --- /dev/null +++ b/assets/js/main.89d2e621.js @@ -0,0 +1,2 @@ +/*! For license information please see main.89d2e621.js.LICENSE.txt */ +(self.webpackChunk_graphql_markdown_website=self.webpackChunk_graphql_markdown_website||[]).push([[8792],{92413:(e,t,n)=>{"use strict";n.d(t,{A:()=>p});n(96540);var a=n(53259),r=n.n(a),i=n(84054);const o={"003e744a":[()=>n.e(7447).then(n.bind(n,23741)),"@site/examples/default/types/objects/media-edge.mdx",23741],"00c45b3c":[()=>n.e(9361).then(n.bind(n,16535)),"@site/examples/default/types/objects/revision-history.mdx",16535],"0156229c":[()=>n.e(2915).then(n.bind(n,33831)),"@site/examples/default/types/inputs/ani-chart-highlight-input.mdx",33831],"01640e11":[()=>n.e(3795).then(n.bind(n,90761)),"@site/examples/default/types/objects/report.mdx",90761],"018fafec":[()=>n.e(1861).then(n.bind(n,16292)),"@site/examples/default/types/objects/ani-chart-user.mdx",16292],"01cfdc5d":[()=>n.e(317).then(n.bind(n,81282)),"@site/examples/default/api/queries/media-trend.mdx",81282],"023538b6":[()=>n.e(8704).then(n.bind(n,16837)),"@site/examples/default/api/queries/following.mdx",16837],"023bde5e":[()=>n.e(5093).then(n.t.bind(n,1220,19)),"~docs/example-group-by/category-examplesgroup-by-schemasidebar-category-mutations-overview-1ac.json",1220],"03226a58":[()=>n.e(2188).then(n.bind(n,70624)),"@site/examples/default/types/objects/media-trend-connection.mdx",70624],"036c8d62":[()=>n.e(1157).then(n.bind(n,2992)),"@site/examples/group-by/grade/mutations/update-grade.mdx",2992],"04162275":[()=>n.e(7478).then(n.bind(n,29432)),"@site/examples/default/api/mutations/save-review.mdx",29432],"04481079":[()=>n.e(6640).then(n.bind(n,56627)),"@site/examples/default/types/enums/media-source.mdx",56627],"04b1d145":[()=>n.e(7684).then(n.bind(n,50848)),"@site/examples/default/types/enums/thread-sort.mdx",50848],"04ff3e00":[()=>n.e(6475).then(n.bind(n,29970)),"@site/examples/default/api/queries/media-tag-collection.mdx",29970],"05c285e5":[()=>n.e(8042).then(n.bind(n,46695)),"@site/examples/default/types/objects/activity-reply-like-notification.mdx",46695],"06fd0db3":[()=>n.e(4494).then(n.bind(n,1673)),"@site/examples/default/types/objects/media-character.mdx",1673],"07305c4a":[()=>n.e(7652).then(n.bind(n,8847)),"@site/api/index.md",8847],"07bc5bcd":[()=>n.e(7969).then(n.bind(n,53808)),"@site/docs/advanced/group-by-directive.md",53808],"084530b4":[()=>n.e(6349).then(n.bind(n,25042)),"@site/examples/default/types/enums/user-title-language.mdx",25042],"08f5cb43":[()=>n.e(7696).then(n.bind(n,36446)),"@site/examples/default/types/objects/fuzzy-date.mdx",36446],"091fb230":[()=>n.e(2218).then(n.bind(n,55043)),"@site/examples/default/types/objects/media.mdx",55043],"09394ec1":[()=>n.e(6303).then(n.t.bind(n,61966,19)),"/graphql-markdown/.docusaurus/docusaurus-plugin-content-docs/default/plugin-route-context-module-100.json",61966],"0999c2f7":[()=>n.e(2602).then(n.bind(n,7650)),"@site/api/utils/prettier.md",7650],"0a7d017c":[()=>n.e(5768).then(n.bind(n,23528)),"@site/examples/default/types/objects/media-streaming-episode.mdx",23528],"0ab05967":[()=>n.e(5419).then(n.t.bind(n,67810,19)),"~docs/default/category-docs-defaultsidebar-category-advanced-settings-50f.json",67810],"0adf84fc":[()=>n.e(3257).then(n.bind(n,62460)),"@site/examples/default/types/objects/site-statistics.mdx",62460],"0aee5409":[()=>n.e(8146).then(n.bind(n,38252)),"@site/api/graphql/guard.md",38252],"0b097e3c":[()=>n.e(9766).then(n.bind(n,85192)),"@site/examples/default/types/objects/activity-like-notification.mdx",85192],"0bcff0e5":[()=>n.e(7810).then(n.bind(n,57902)),"@site/docs/advanced/custom-deprecated-section.md",57902],"0c50f552":[()=>n.e(4413).then(n.bind(n,88097)),"@site/examples/default/types/objects/character-submission.mdx",88097],"0cba5814":[()=>n.e(4947).then(n.bind(n,45341)),"@site/api/core/config.md",45341],"0e384e19":[()=>n.e(3976).then(n.bind(n,19562)),"@site/docs/intro.md",19562],"0e545f28":[()=>n.e(3318).then(n.bind(n,13813)),"@site/examples/default/types/enums/user-statistics-sort.mdx",13813],"0e9f66e8":[()=>n.e(4).then(n.t.bind(n,98532,19)),"~docs/example-group-by/category-examplesgroup-by-schemasidebar-category-queries-overview-492.json",98532],"1082e960":[()=>n.e(6678).then(n.bind(n,80780)),"@site/examples/group-by/course/mutations/add-course.mdx",80780],"10c06ae2":[()=>n.e(619).then(n.bind(n,44914)),"@site/examples/default/types/objects/user.mdx",44914],"113dff62":[()=>n.e(3124).then(n.bind(n,4046)),"@site/examples/default/types/enums/user-staff-name-language.mdx",4046],"13c2fcb7":[()=>n.e(12).then(n.t.bind(n,7451,19)),"~docs/example-group-by/category-examplesgroup-by-schemasidebar-category-course-overview-1-a95.json",7451],"13d7256f":[()=>n.e(6583).then(n.bind(n,41011)),"@site/examples/default/types/inputs/media-list-options-input.mdx",41011],"143a31d6":[()=>n.e(6098).then(n.t.bind(n,2641,19)),"~docs/example-group-by/category-examplesgroup-by-schemasidebar-category-course-overview-612.json",2641],"14eb3368":[()=>Promise.all([n.e(1869),n.e(6969)]).then(n.bind(n,73533)),"@theme/DocCategoryGeneratedIndexPage",73533],"168260b6":[()=>n.e(1178).then(n.bind(n,80461)),"@site/examples/default/types/objects/list-activity.mdx",80461],17896441:[()=>Promise.all([n.e(1869),n.e(8401)]).then(n.bind(n,15027)),"@theme/DocItem",15027],"182b1744":[()=>n.e(1716).then(n.bind(n,56183)),"@site/examples/default/types/objects/studio-stats.mdx",56183],"18d91b36":[()=>n.e(2979).then(n.bind(n,92844)),"@site/examples/default/types/objects/activity-message-notification.mdx",92844],"1943c7e8":[()=>n.e(1543).then(n.bind(n,18123)),"@site/examples/default/types/objects/user-options.mdx",18123],"1a1d477d":[()=>n.e(860).then(n.bind(n,21035)),"@site/examples/group-by/common/directives/example.mdx",21035],"1a33f037":[()=>n.e(1535).then(n.bind(n,29303)),"@site/examples/default/types/objects/studio-edge.mdx",29303],"1aa943f7":[()=>n.e(6217).then(n.bind(n,88331)),"@site/docs/advanced/homepage.md",88331],"1c06cedb":[()=>n.e(59).then(n.bind(n,8181)),"@site/examples/default/api/mutations/update-user.mdx",8181],"1c1345ba":[()=>n.e(8025).then(n.t.bind(n,99223,19)),"~docs/example-group-by/category-examplesgroup-by-schemasidebar-category-queries-overview-1-f44.json",99223],"1c13805c":[()=>n.e(5883).then(n.bind(n,24285)),"@site/examples/default/types/scalars/id.mdx",24285],"1f4d8c42":[()=>n.e(4223).then(n.bind(n,61182)),"@site/examples/default/types/enums/external-link-type.mdx",61182],"212af331":[()=>n.e(5122).then(n.bind(n,79395)),"@site/examples/default/types/enums/media-season.mdx",79395],"21a7e9b3":[()=>n.e(3179).then(n.bind(n,21766)),"@site/api/docusaurus/globals.md",21766],"21ea27f0":[()=>n.e(7045).then(n.bind(n,99547)),"@site/examples/default/types/objects/activity-reply-notification.mdx",99547],"234895fd":[()=>n.e(5526).then(n.bind(n,40227)),"@site/examples/group-by/common/objects/semester.mdx",40227],"243a1d1a":[()=>n.e(1428).then(n.t.bind(n,57579,19)),"/graphql-markdown/.docusaurus/docusaurus-plugin-content-docs/api/plugin-route-context-module-100.json",57579],24561158:[()=>n.e(9589).then(n.t.bind(n,39933,19)),"~docs/example-group-by/version-current-metadata-prop-751.json",39933],"24e490e7":[()=>n.e(8077).then(n.bind(n,78191)),"@site/examples/group-by/grade/mutations/update-gpa.mdx",78191],"25c6c18f":[()=>n.e(6005).then(n.bind(n,5459)),"@site/examples/default/types/inputs/airing-schedule-input.mdx",5459],"25ea20ee":[()=>n.e(7682).then(n.bind(n,15744)),"@site/examples/default/api/mutations/save-thread.mdx",15744],"26c5d951":[()=>n.e(4244).then(n.bind(n,16284)),"@site/examples/group-by/common/queries/search-role.mdx",16284],"26ea030f":[()=>n.e(3304).then(n.bind(n,83287)),"@site/examples/default/types/enums/user-sort.mdx",83287],"27b16d00":[()=>n.e(3399).then(n.bind(n,95963)),"@site/api/printer-legacy/graphql/object.md",95963],"2807d1a0":[()=>n.e(7292).then(n.bind(n,50757)),"@site/examples/default/api/queries/activity.mdx",50757],"280d90d7":[()=>n.e(5013).then(n.bind(n,80875)),"@site/examples/default/types/objects/airing-schedule-edge.mdx",80875],"287d049f":[()=>n.e(373).then(n.bind(n,34567)),"@site/api/printer-legacy/graphql/operation.md",34567],"29462eb0":[()=>n.e(9855).then(n.bind(n,47204)),"@site/examples/default/types/objects/genre-stats.mdx",47204],"2a59f4b4":[()=>n.e(3358).then(n.bind(n,85760)),"@site/examples/default/types/scalars/boolean.mdx",85760],"2a7b19de":[()=>n.e(7856).then(n.bind(n,2049)),"@site/examples/group-by/common/directives/complexity.mdx",2049],"2a9cb831":[()=>n.e(7158).then(n.bind(n,51157)),"@site/examples/default/types/scalars/string.mdx",51157],"2afa5c84":[()=>n.e(1319).then(n.bind(n,41124)),"@site/examples/default/types/enums/staff-language.mdx",41124],"2c24e59e":[()=>n.e(524).then(n.bind(n,67824)),"@site/api/printer-legacy/printer.md",67824],"2c732521":[()=>n.e(1540).then(n.bind(n,28781)),"@site/examples/default/types/objects/user-genre-statistic.mdx",28781],"2cc5819e":[()=>n.e(385).then(n.bind(n,96524)),"@site/examples/default/types/enums/thread-comment-sort.mdx",96524],"2e4eea4e":[()=>n.e(9834).then(n.bind(n,18374)),"@site/examples/default/api/mutations/save-media-list-entry.mdx",18374],"2e57b0d8":[()=>n.e(8002).then(n.bind(n,80074)),"@site/api/printer-legacy/example.md",80074],"2e812fa2":[()=>n.e(8656).then(n.bind(n,74463)),"@site/examples/default/types/enums/notification-type.mdx",74463],"2faad2c9":[()=>n.e(6859).then(n.bind(n,8218)),"@site/examples/default/types/inputs/fuzzy-date-input.mdx",8218],"307fd5b1":[()=>n.e(5779).then(n.bind(n,30527)),"@site/examples/default/types/scalars/fuzzy-date-int.mdx",30527],"314ba28c":[()=>n.e(2955).then(n.bind(n,68645)),"@site/examples/default/api/mutations/update-ani-chart-settings.mdx",68645],"3182ec47":[()=>n.e(9250).then(n.t.bind(n,53901,19)),"~docs/example-group-by/category-examplesgroup-by-schemasidebar-category-interfaces-overview-afe.json",53901],"31979d80":[()=>n.e(6312).then(n.bind(n,93610)),"@site/examples/group-by/common/scalars/boolean.mdx",93610],32774866:[()=>n.e(2178).then(n.bind(n,52689)),"@site/examples/default/types/objects/media-trailer.mdx",52689],"33344a41":[()=>n.e(5068).then(n.t.bind(n,4061,19)),"/graphql-markdown/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json",4061],"337c323a":[()=>n.e(7792).then(n.bind(n,80673)),"@site/examples/default/types/enums/activity-type.mdx",80673],"33fa1d98":[()=>n.e(8154).then(n.bind(n,79308)),"@site/examples/default/types/objects/site-trend.mdx",79308],"342b9389":[()=>n.e(1191).then(n.bind(n,95454)),"@site/examples/default/api/mutations/toggle-follow.mdx",95454],"34a35eb5":[()=>n.e(8423).then(n.bind(n,81660)),"@site/examples/default/api/queries/studio.mdx",81660],35633510:[()=>n.e(5981).then(n.bind(n,19629)),"@site/examples/group-by/common/directives/specified-by.mdx",19629],"36a0df4f":[()=>n.e(9167).then(n.bind(n,93525)),"@site/examples/default/types/enums/mod-action-type.mdx",93525],"36ddcd3a":[()=>n.e(8729).then(n.bind(n,80467)),"@site/examples/default/types/scalars/int.mdx",80467],"38282ee3":[()=>n.e(2571).then(n.bind(n,2350)),"@site/examples/default/api/queries/review.mdx",2350],"3b1e3b2e":[()=>n.e(8614).then(n.t.bind(n,46537,19)),"~docs/example-group-by/category-examplesgroup-by-schemasidebar-category-scalars-overview-3c1.json",46537],"3c141ee6":[()=>n.e(4865).then(n.bind(n,97760)),"@site/examples/default/types/enums/recommendation-rating.mdx",97760],"3d4b4798":[()=>n.e(2752).then(n.bind(n,73536)),"@site/examples/default/types/scalars/json.mdx",73536],"3d902d0e":[()=>n.e(1658).then(n.t.bind(n,85611,19)),"~docs/example-group-by/category-examplesgroup-by-schemasidebar-category-queries-overview-3-1a6.json",85611],"3ed953fa":[()=>n.e(3129).then(n.bind(n,33807)),"@site/examples/group-by/common/directives/auth.mdx",33807],"3f29fcc0":[()=>n.e(7491).then(n.bind(n,83039)),"@site/examples/default/types/inputs/list-activity-option-input.mdx",83039],"3f882556":[()=>n.e(5182).then(n.bind(n,40255)),"@site/examples/default/types/objects/staff-stats.mdx",40255],"427370f4":[()=>n.e(176).then(n.bind(n,55880)),"@site/examples/default/types/objects/activity-reply-subscribed-notification.mdx",55880],"42d4d946":[()=>n.e(5158).then(n.t.bind(n,22807,19)),"~docs/api/category-api-defaultsidebar-category-graphql-markdowntypes-c32.json",22807],"442db21e":[()=>n.e(6811).then(n.bind(n,27823)),"@site/examples/default/types/objects/list-activity-option.mdx",27823],"44c6aa82":[()=>n.e(3580).then(n.bind(n,99114)),"@site/examples/default/types/objects/related-media-addition-notification.mdx",99114],"44e06fa5":[()=>n.e(7874).then(n.bind(n,13389)),"@site/examples/default/api/queries/character.mdx",13389],"4506323d":[()=>n.e(9474).then(n.bind(n,93266)),"@site/examples/default/types/objects/media-connection.mdx",93266],"45bc7e59":[()=>n.e(9881).then(n.t.bind(n,86345,19)),"/graphql-markdown/.docusaurus/docusaurus-plugin-content-docs/example-default/plugin-route-context-module-100.json",86345],"45c285c7":[()=>n.e(9226).then(n.bind(n,76871)),"@site/examples/default/api/queries/recommendation.mdx",76871],"4605ad24":[()=>n.e(8033).then(n.bind(n,93010)),"@site/examples/default/types/objects/notification-option.mdx",93010],"4775b693":[()=>n.e(5092).then(n.bind(n,13598)),"@site/examples/default/types/objects/media-submission-edge.mdx",13598],"47ead570":[()=>n.e(5765).then(n.bind(n,96769)),"@site/examples/default/types/enums/media-list-status.mdx",96769],"481e7485":[()=>n.e(2297).then(n.bind(n,72616)),"@site/examples/default/types/inputs/notification-option-input.mdx",72616],"482c9820":[()=>n.e(9687).then(n.bind(n,18424)),"@site/examples/default/api/mutations/toggle-like.mdx",18424],"48ecabb7":[()=>n.e(6479).then(n.bind(n,4834)),"@site/examples/default/types/objects/media-merge-notification.mdx",4834],"4990b34e":[()=>n.e(9733).then(n.bind(n,84761)),"@site/examples/default/types/objects/media-cover-image.mdx",84761],"4c0ed73e":[()=>n.e(4438).then(n.bind(n,49386)),"@site/examples/default/types/objects/user-status-statistic.mdx",49386],"4c49906c":[()=>n.e(8923).then(n.bind(n,93608)),"@site/examples/default/types/enums/submission-sort.mdx",93608],"4c5a1286":[()=>n.e(5117).then(n.bind(n,65867)),"@site/examples/default/types/enums/character-role.mdx",65867],"4cceef73":[()=>n.e(4099).then(n.t.bind(n,23840,19)),"~docs/example-group-by/category-examplesgroup-by-schemasidebar-category-grade-overview-84b.json",23840],"4d3914ba":[()=>n.e(9187).then(n.t.bind(n,86334,19)),"~docs/api/category-api-defaultsidebar-category-graphql-markdowndocusaurus-3dc.json",86334],"4ea83d6a":[()=>n.e(4775).then(n.bind(n,9438)),"@site/api/utils/fs.md",9438],"4ec2cec0":[()=>n.e(5028).then(n.bind(n,18334)),"@site/examples/default/types/objects/user-voice-actor-statistic.mdx",18334],"4f6bc8f8":[()=>n.e(3338).then(n.bind(n,57331)),"@site/examples/group-by/common/scalars/string.mdx",57331],"50050ce9":[()=>n.e(6596).then(n.bind(n,37406)),"@site/examples/default/types/enums/submission-status.mdx",37406],"50c19381":[()=>n.e(2113).then(n.bind(n,62079)),"@site/api/helpers/directives/descriptor.md",62079],"50faeecd":[()=>n.e(3860).then(n.bind(n,85267)),"@site/examples/group-by/grade/queries/gpa.mdx",85267],"51502e79":[()=>n.e(8837).then(n.bind(n,21863)),"@site/examples/group-by/common/directives/beta.mdx",21863],"5162ca4e":[()=>n.e(7196).then(n.bind(n,81734)),"@site/examples/default/types/objects/character-edge.mdx",81734],"51854e3b":[()=>n.e(6158).then(n.bind(n,83207)),"@site/examples/default/types/enums/character-sort.mdx",83207],"52d20703":[()=>n.e(6712).then(n.bind(n,20509)),"@site/examples/default/api/mutations/update-ani-chart-highlights.mdx",20509],"5342b135":[()=>n.e(8726).then(n.bind(n,15890)),"@site/examples/default/types/objects/user-start-year-statistic.mdx",15890],"5395316c":[()=>n.e(1768).then(n.bind(n,8367)),"@site/examples/default/types/objects/user-statistic-types.mdx",8367],"5599d3aa":[()=>n.e(3118).then(n.bind(n,3654)),"@site/examples/group-by/deprecated/course/queries/science-courses.mdx",3654],"568dac4a":[()=>n.e(339).then(n.bind(n,1120)),"@site/examples/default/types/enums/mod-role.mdx",1120],"5699f4d3":[()=>n.e(5921).then(n.bind(n,78632)),"@site/examples/default/types/directives/deprecated.mdx",78632],57085653:[()=>n.e(1990).then(n.bind(n,62710)),"@site/examples/default/api/directives/include.mdx",62710],58360224:[()=>n.e(2579).then(n.bind(n,75793)),"@site/examples/group-by/common/scalars/int.mdx",75793],"58c52dd2":[()=>n.e(6072).then(n.bind(n,35886)),"@site/examples/default/types/objects/user-staff-statistic.mdx",35886],"5b591a03":[()=>n.e(9017).then(n.bind(n,19553)),"@site/examples/default/types/objects/tag-stats.mdx",19553],"5c7c1faa":[()=>n.e(5754).then(n.bind(n,6364)),"@site/api/helpers/utils/interpolate.md",6364],"5dde45b4":[()=>n.e(9798).then(n.bind(n,83457)),"@site/examples/default/types/objects/media-trend.mdx",83457],"5e65379d":[()=>n.e(2795).then(n.bind(n,11579)),"@site/examples/default/types/objects/media-list-options.mdx",11579],"5e95c892":[()=>n.e(9647).then(n.bind(n,83124)),"@theme/DocsRoot",83124],"5e9f5e1a":[()=>Promise.resolve().then(n.bind(n,4784)),"@generated/docusaurus.config",4784],"5ed2c5c6":[()=>n.e(7795).then(n.bind(n,93504)),"@site/examples/default/types/objects/mod-action.mdx",93504],"610b368d":[()=>n.e(9005).then(n.bind(n,35660)),"@site/examples/default/types/objects/media-list-type-options.mdx",35660],"611cf60e":[()=>n.e(5489).then(n.bind(n,70061)),"@site/examples/default/api/mutations/save-recommendation.mdx",70061],"61c4e8e8":[()=>n.e(6277).then(n.bind(n,85057)),"@site/examples/default/types/objects/staff-name.mdx",85057],"61fdff18":[()=>n.e(3109).then(n.bind(n,29617)),"@site/examples/default/api/queries/ani-chart-user.mdx",29617],"625ccf85":[()=>n.e(5497).then(n.bind(n,65090)),"@site/examples/default/api/queries/staff.mdx",65090],"63bab374":[()=>n.e(9325).then(n.bind(n,28938)),"@site/examples/default/types/objects/page.mdx",28938],"64851f1b":[()=>n.e(5936).then(n.bind(n,11518)),"@site/examples/default/types/scalars/float.mdx",11518],"654eb3dd":[()=>n.e(4652).then(n.t.bind(n,4215,19)),"~docs/api/version-current-metadata-prop-751.json",4215],"65b7c4b9":[()=>n.e(3895).then(n.bind(n,10100)),"@site/examples/default/types/inputs/media-title-input.mdx",10100],"65ff014b":[()=>n.e(415).then(n.bind(n,28402)),"@site/api/printer-legacy/relation.md",28402],"66355ea0":[()=>n.e(5698).then(n.bind(n,73406)),"@site/examples/default/types/objects/media-submission.mdx",73406],"667036e7":[()=>n.e(2377).then(n.bind(n,66752)),"@site/examples/group-by/common/interfaces/record.mdx",66752],"671e5a92":[()=>n.e(4271).then(n.bind(n,26361)),"@site/examples/default/types/objects/media-list-collection.mdx",26361],"67c5b3f9":[()=>n.e(1564).then(n.bind(n,96002)),"@site/api/printer-legacy/frontmatter.md",96002],"690431c1":[()=>n.e(612).then(n.bind(n,85444)),"@site/api/core/renderer.md",85444],"693537a7":[()=>n.e(9346).then(n.bind(n,16073)),"@site/examples/group-by/grade/queries/un-weighted-gpa.mdx",16073],"6960e70f":[()=>n.e(9704).then(n.t.bind(n,63479,19)),"~docs/example-group-by/category-examplesgroup-by-schemasidebar-category-enums-overview-0f8.json",63479],"6a7ea3b7":[()=>n.e(6049).then(n.bind(n,70474)),"@site/examples/default/types/objects/recommendation-edge.mdx",70474],"6aee3f4e":[()=>n.e(7160).then(n.bind(n,78623)),"@site/examples/default/types/objects/site-trend-connection.mdx",78623],"6b700a07":[()=>n.e(3660).then(n.bind(n,1602)),"@site/examples/group-by/common/objects/department-information.mdx",1602],"6b9371a2":[()=>n.e(1466).then(n.bind(n,36566)),"@site/api/printer-legacy/link.md",36566],"6bfed8d6":[()=>n.e(5614).then(n.bind(n,85730)),"@site/api/graphql/introspection.md",85730],"6ca537f5":[()=>n.e(3169).then(n.bind(n,20079)),"@site/api/printer-legacy/code.md",20079],"6e333e68":[()=>n.e(36).then(n.bind(n,21788)),"@site/examples/default/types/unions/activity-union.mdx",21788],"6e8812e8":[()=>n.e(2638).then(n.bind(n,36012)),"@site/docs/advanced/custom-directive.md",36012],"6ead0a87":[()=>n.e(5685).then(n.bind(n,29175)),"@site/examples/default/types/objects/thread.mdx",29175],"6ec4d7a4":[()=>n.e(9369).then(n.bind(n,16364)),"@site/examples/default/types/objects/user-previous-name.mdx",16364],"70701d30":[()=>n.e(3265).then(n.bind(n,68692)),"@site/examples/default/types/enums/review-sort.mdx",68692],"714614bc":[()=>n.e(4835).then(n.bind(n,90163)),"@site/examples/default/api/queries/media-list.mdx",90163],"737bf32e":[()=>n.e(4300).then(n.t.bind(n,89950,19)),"~docs/example-group-by/category-examplesgroup-by-schemasidebar-category-objects-overview-02a.json",89950],"73d1228f":[()=>n.e(3146).then(n.bind(n,43986)),"@site/examples/default/types/objects/message-activity.mdx",43986],"7485ae2a":[()=>n.e(9906).then(n.bind(n,20876)),"@site/docs/get-started.md",20876],"7583257a":[()=>n.e(1123).then(n.bind(n,2362)),"@site/examples/default/types/objects/score-distribution.mdx",2362],"772929aa":[()=>n.e(8699).then(n.bind(n,21064)),"@site/examples/default/api/mutations/delete-media-list-entry.mdx",21064],"77495b7a":[()=>n.e(8117).then(n.bind(n,25714)),"@site/examples/default/types/objects/text-activity.mdx",25714],77549607:[()=>n.e(1992).then(n.bind(n,72017)),"@site/examples/default/types/objects/airing-schedule.mdx",72017],"786eccda":[()=>n.e(518).then(n.bind(n,89496)),"@site/examples/default/types/objects/media-rank.mdx",89496],"78d8ee9b":[()=>n.e(157).then(n.bind(n,81554)),"@site/examples/group-by/common/directives/deprecated.mdx",81554],"7934b661":[()=>n.e(7565).then(n.bind(n,26865)),"@site/examples/default/api/mutations/delete-activity.mdx",26865],"79e76417":[()=>n.e(5029).then(n.bind(n,59307)),"@site/examples/default/types/objects/thread-comment-like-notification.mdx",59307],"7a760757":[()=>n.e(4159).then(n.bind(n,25524)),"@site/examples/default/types/objects/studio-connection.mdx",25524],"7ad144b1":[()=>n.e(6037).then(n.bind(n,48758)),"@site/examples/group-by/course/mutations/drop-course.mdx",48758],"7b579646":[()=>n.e(9515).then(n.bind(n,1282)),"@site/examples/default/types/objects/media-title.mdx",1282],"7bad1a78":[()=>n.e(5260).then(n.t.bind(n,19283,19)),"~docs/example-group-by/category-examplesgroup-by-schemasidebar-category-directives-overview-85a.json",19283],"7bc6184d":[()=>n.e(6848).then(n.bind(n,19411)),"@site/examples/default/types/objects/review.mdx",19411],"7c35929c":[()=>n.e(9092).then(n.bind(n,18720)),"@site/examples/default/types/objects/character-submission-connection.mdx",18720],"7c45ddd1":[()=>n.e(2409).then(n.t.bind(n,47725,19)),"~docs/api/category-api-defaultsidebar-category-graphql-markdowngraphql-afa.json",47725],"7c547b29":[()=>n.e(3202).then(n.bind(n,37614)),"@site/examples/group-by/common/objects/course.mdx",37614],"7c7af11d":[()=>n.e(9157).then(n.bind(n,26124)),"@site/examples/default/types/objects/staff-connection.mdx",26124],"7c7d3934":[()=>n.e(8009).then(n.bind(n,51287)),"@site/api/printer-legacy/common.md",51287],"7cbd8e53":[()=>n.e(6070).then(n.bind(n,28536)),"@site/examples/default/types/objects/list-score-stats.mdx",28536],"7cc2b776":[()=>n.e(2912).then(n.bind(n,82887)),"@site/examples/default/types/objects/user-release-year-statistic.mdx",82887],"7d19aa68":[()=>n.e(7772).then(n.t.bind(n,45262,19)),"~docs/api/category-api-defaultsidebar-category-graphql-markdowndiff-7bf.json",45262],"7d4c4e48":[()=>n.e(3568).then(n.bind(n,8794)),"@site/examples/default/types/objects/status-distribution.mdx",8794],"7d9c7553":[()=>n.e(7898).then(n.bind(n,51976)),"@site/examples/default/api/mutations/toggle-favourite.mdx",51976],"7dc02a78":[()=>n.e(8825).then(n.t.bind(n,78750,19)),"~docs/api/category-api-defaultsidebar-category-graphql-markdownhelpers-959.json",78750],"7e063903":[()=>n.e(2110).then(n.bind(n,11260)),"@site/docs/advanced/additional-schema.md",11260],"7e8abdda":[()=>n.e(6845).then(n.bind(n,58549)),"@site/examples/default/types/objects/recommendation-connection.mdx",58549],"7ea1f064":[()=>n.e(7781).then(n.bind(n,13275)),"@site/examples/default/api/mutations/toggle-like-v2.mdx",13275],"7f4d4470":[()=>n.e(458).then(n.bind(n,66918)),"@site/examples/default/types/objects/character.mdx",66918],"7f817204":[()=>n.e(610).then(n.bind(n,48181)),"@site/examples/default/types/enums/site-trend-sort.mdx",48181],"80f1c2a8":[()=>n.e(3200).then(n.bind(n,17137)),"@site/examples/default/types/enums/activity-sort.mdx",17137],"819e3d9d":[()=>n.e(7122).then(n.bind(n,62246)),"@site/examples/default/types/objects/year-stats.mdx",62246],"8281109b":[()=>n.e(1286).then(n.bind(n,15525)),"@site/examples/default/types/enums/media-format.mdx",15525],"8418cd69":[()=>n.e(3802).then(n.bind(n,59402)),"@site/examples/default/api/queries/media-list-collection.mdx",59402],"842fa232":[()=>n.e(433).then(n.bind(n,41139)),"@site/examples/default/api/queries/like.mdx",41139],"845059a0":[()=>n.e(3069).then(n.bind(n,14760)),"@site/examples/default/types/objects/following-notification.mdx",14760],"847a047e":[()=>n.e(2843).then(n.bind(n,93398)),"@site/api/printer-legacy/const/options.md",93398],"86ccf3fa":[()=>n.e(2061).then(n.bind(n,91734)),"@site/examples/default/api/mutations/delete-thread-comment.mdx",91734],"8767c401":[()=>n.e(3545).then(n.bind(n,70554)),"@site/examples/default/api/mutations/delete-thread.mdx",70554],"87ad2ba5":[()=>n.e(5585).then(n.bind(n,69446)),"@site/examples/default/types/objects/media-submission-comparison.mdx",69446],"87b603ac":[()=>n.e(1475).then(n.bind(n,28047)),"@site/examples/default/types/objects/thread-comment.mdx",28047],"881202c4":[()=>n.e(414).then(n.bind(n,97101)),"@site/docs/advanced/schema-loading.md",97101],"887070eb":[()=>n.e(3874).then(n.bind(n,41503)),"@site/examples/group-by/common/scalars/time.mdx",41503],89554646:[()=>n.e(784).then(n.bind(n,77619)),"@site/api/printer-legacy/graphql/directive.md",77619],"89cfe9ab":[()=>n.e(9558).then(n.bind(n,72390)),"@site/examples/default/types/objects/media-deletion-notification.mdx",72390],"89d2d034":[()=>n.e(7345).then(n.bind(n,71482)),"@site/examples/default/types/enums/media-status.mdx",71482],"8a5700eb":[()=>n.e(6099).then(n.bind(n,49310)),"@site/examples/default/types/scalars/country-code.mdx",49310],"8a94ae17":[()=>n.e(1275).then(n.bind(n,95772)),"@site/examples/default/types/objects/deleted.mdx",95772],"8cd5ecab":[()=>n.e(4136).then(n.bind(n,2016)),"@site/examples/group-by/common/directives/skip.mdx",2016],"8cf9d678":[()=>n.e(6336).then(n.bind(n,29908)),"@site/examples/group-by/common/scalars/date.mdx",29908],"8d936e6f":[()=>n.e(7916).then(n.bind(n,66097)),"@site/api/core/graphql-config.md",66097],"8dc187fb":[()=>n.e(2664).then(n.bind(n,95866)),"@site/examples/default/types/objects/recommendation.mdx",95866],"8ddfe043":[()=>n.e(9853).then(n.bind(n,38480)),"@site/examples/default/types/objects/format-stats.mdx",38480],"8e3d6d7f":[()=>n.e(442).then(n.bind(n,96819)),"@site/examples/default/types/objects/activity-reply.mdx",96819],"8fcf414e":[()=>n.e(5826).then(n.bind(n,52549)),"@site/examples/default/types/objects/staff.mdx",52549],"929f041f":[()=>n.e(8870).then(n.bind(n,6590)),"@site/examples/default/api/queries/thread.mdx",6590],"92c78daf":[()=>n.e(8101).then(n.bind(n,33415)),"@site/api/graphql/formatter.md",33415],"93115ec1":[()=>n.e(1415).then(n.bind(n,15655)),"@site/examples/default/types/objects/staff-role-type.mdx",15655],"935f2afb":[()=>n.e(8581).then(n.t.bind(n,35610,19)),"~docs/default/version-current-metadata-prop-751.json",35610],"938b2e2b":[()=>n.e(3966).then(n.bind(n,41112)),"@site/examples/default/api/queries/media.mdx",41112],"93f7c24a":[()=>n.e(9580).then(n.bind(n,8034)),"@site/examples/default/types/objects/media-list.mdx",8034],"947c35cb":[()=>n.e(9897).then(n.bind(n,68634)),"@site/examples/default/api/queries/activity-reply.mdx",68634],"94f3ae5a":[()=>n.e(8221).then(n.bind(n,77216)),"@site/api/logger/globals.md",77216],95192101:[()=>n.e(1989).then(n.bind(n,28034)),"@site/examples/default/types/objects/thread-category.mdx",28034],"9574e821":[()=>n.e(7612).then(n.bind(n,64780)),"@site/examples/default/api/mutations/save-activity-reply.mdx",64780],"966509c8":[()=>n.e(8253).then(n.bind(n,45931)),"@site/examples/group-by/common/scalars/id.mdx",45931],"96abd297":[()=>n.e(705).then(n.bind(n,94664)),"@site/docs/advanced/examples.md",94664],"9729b22b":[()=>n.e(560).then(n.bind(n,47537)),"@site/examples/default/api/mutations/save-message-activity.mdx",47537],"988d23d8":[()=>n.e(6657).then(n.bind(n,30598)),"@site/api/graphql/group.md",30598],"99464b0a":[()=>n.e(9632).then(n.bind(n,76443)),"@site/examples/default/types/objects/media-trend-edge.mdx",76443],"998399de":[()=>n.e(8049).then(n.bind(n,55596)),"@site/examples/default/types/enums/media-sort.mdx",55596],"99c1f9c8":[()=>n.e(2068).then(n.bind(n,22326)),"@site/examples/default/types/objects/user-country-statistic.mdx",22326],"99e67184":[()=>n.e(3816).then(n.bind(n,26529)),"@site/examples/group-by/common/scalars/url.mdx",26529],"9a93a67d":[()=>n.e(3401).then(n.bind(n,40888)),"@site/examples/default/types/objects/user-length-statistic.mdx",40888],"9c112434":[()=>n.e(3602).then(n.bind(n,62843)),"@site/examples/group-by/common/directives/doc.mdx",62843],"9c4d9520":[()=>n.e(1915).then(n.bind(n,76764)),"@site/examples/default/types/inputs/media-external-link-input.mdx",76764],"9d9f8394":[()=>n.e(9013).then(n.bind(n,87726)),"@site/docs/troubleshooting.md",87726],"9de9df72":[()=>n.e(2747).then(n.bind(n,71434)),"@site/docs/advanced/docs-multi-instance.md",71434],"9e1bb2aa":[()=>n.e(7226).then(n.t.bind(n,95053,19)),"~docs/api/category-api-defaultsidebar-category-utils-6af.json",95053],"9e6be27b":[()=>n.e(9611).then(n.bind(n,33865)),"@site/examples/default/api/directives/skip.mdx",33865],"9ed00105":[()=>n.e(3873).then(n.bind(n,77750)),"@site/docs/configuration.md",77750],"9edf951f":[()=>n.e(4556).then(n.bind(n,26100)),"@site/examples/default/api/mutations/toggle-activity-pin.mdx",26100],"9f0677d8":[()=>n.e(9866).then(n.bind(n,66537)),"@site/examples/default/api/queries/external-link-source-collection.mdx",66537],a07edc37:[()=>n.e(9233).then(n.bind(n,71061)),"@site/examples/default/types/inputs/staff-name-input.mdx",71061],a4719194:[()=>n.e(9821).then(n.bind(n,37229)),"@site/examples/default/types/objects/user-activity-history.mdx",37229],a4d34d3a:[()=>n.e(4427).then(n.bind(n,27536)),"@site/examples/default/types/objects/airing-schedule-connection.mdx",27536],a50ba5a5:[()=>n.e(3087).then(n.bind(n,63736)),"@site/examples/default/api/mutations/update-favourite-order.mdx",63736],a7bd4aaa:[()=>n.e(7098).then(n.bind(n,22881)),"@theme/DocVersionRoot",22881],a8b07c5e:[()=>n.e(8466).then(n.bind(n,65411)),"@site/examples/default/api/queries/user.mdx",65411],a94703ab:[()=>Promise.all([n.e(1869),n.e(9048)]).then(n.bind(n,74644)),"@theme/DocRoot",74644],a9a5195e:[()=>n.e(7051).then(n.bind(n,50354)),"@site/examples/default/types/objects/character-image.mdx",50354],aadc2a35:[()=>n.e(1110).then(n.bind(n,22331)),"@site/examples/default/api/queries/page.mdx",22331],ab25c79e:[()=>n.e(4453).then(n.bind(n,17178)),"@site/api/utils/object.md",17178],ab3156a3:[()=>n.e(9495).then(n.bind(n,93245)),"@site/api/printer-legacy/graphql/interface.md",93245],abd6157e:[()=>n.e(9662).then(n.bind(n,31521)),"@site/examples/group-by/common/directives/no-doc.mdx",31521],ac772c89:[()=>n.e(6417).then(n.bind(n,5333)),"@site/examples/default/types/objects/staff-image.mdx",5333],ad3f96b1:[()=>n.e(5141).then(n.t.bind(n,67415,19)),"~docs/example-group-by/category-examplesgroup-by-schemasidebar-category-deprecated-overview-9fb.json",67415],ad604d10:[()=>n.e(3813).then(n.t.bind(n,14703,19)),"~docs/api/category-api-defaultsidebar-category-const-ebd.json",14703],aec0b6cb:[()=>n.e(8715).then(n.bind(n,75699)),"@site/examples/default/types/enums/review-rating.mdx",75699],aeddb196:[()=>n.e(8155).then(n.bind(n,61007)),"@site/api/printer-legacy/group.md",61007],af7f826a:[()=>n.e(3680).then(n.bind(n,39118)),"@site/api/printer-legacy/const/strings.md",39118],afb3155e:[()=>n.e(4903).then(n.t.bind(n,73162,19)),"~docs/api/category-api-defaultsidebar-category-graphql-2fb.json",73162],b0ac5d39:[()=>n.e(9986).then(n.t.bind(n,32773,19)),"~docs/api/category-api-defaultsidebar-category-graphql-markdownutils-b62.json",32773],b1aa3f71:[()=>Promise.all([n.e(1869),n.e(9038)]).then(n.bind(n,51082)),"@site/examples/group-by/groups.md",51082],b1bc4532:[()=>n.e(2603).then(n.bind(n,56198)),"@site/examples/default/api/mutations/delete-custom-list.mdx",56198],b2340dce:[()=>n.e(9962).then(n.bind(n,82296)),"@site/examples/default/types/objects/user-mod-data.mdx",82296],b2d67f8d:[()=>n.e(1410).then(n.t.bind(n,38103,19)),"~docs/example-group-by/category-examplesgroup-by-schemasidebar-category-mutations-overview-1-e72.json",38103],b309da7b:[()=>n.e(2209).then(n.bind(n,74847)),"@site/examples/default/api/queries/site-statistics.mdx",74847],b32cb846:[()=>n.e(6611).then(n.bind(n,4915)),"@site/examples/default/types/enums/external-link-media-type.mdx",4915],b48f7d9d:[()=>n.e(8577).then(n.bind(n,57033)),"@site/api/printer-legacy/directive.md",57033],b5b39e7d:[()=>n.e(2194).then(n.bind(n,40428)),"@site/examples/default/types/objects/media-list-group.mdx",40428],b6f4de4b:[()=>n.e(1590).then(n.t.bind(n,75110,19)),"~docs/example-group-by/category-examplesgroup-by-schemasidebar-category-common-overview-4bd.json",75110],b706df5f:[()=>n.e(7011).then(n.bind(n,74978)),"@site/examples/default/types/objects/review-connection.mdx",74978],b756024e:[()=>n.e(6548).then(n.t.bind(n,65403,19)),"~docs/api/category-api-defaultsidebar-category-graphql-markdownprinter-legacy-463.json",65403],b835b301:[()=>n.e(1713).then(n.bind(n,48611)),"@site/api/printer-legacy/section.md",48611],b9652c4a:[()=>n.e(4703).then(n.bind(n,38547)),"@site/api/printer-legacy/const/mdx.md",38547],b9ce0da3:[()=>n.e(2964).then(n.bind(n,56836)),"@site/examples/default/types/objects/character-name.mdx",56836],b9d37cda:[()=>n.e(7852).then(n.bind(n,30540)),"@site/examples/default/types/enums/media-relation.mdx",30540],ba4d6643:[()=>n.e(3831).then(n.bind(n,47757)),"@site/examples/default/types/objects/studio.mdx",47757],bb62c5c3:[()=>n.e(2517).then(n.bind(n,97829)),"@site/examples/default/types/objects/media-stats.mdx",97829],bc81805e:[()=>n.e(117).then(n.bind(n,2463)),"@site/examples/default/api/queries/notification.mdx",2463],bcab2f54:[()=>n.e(9548).then(n.bind(n,90252)),"@site/api/core/diff.md",90252],bcfe6899:[()=>n.e(8045).then(n.bind(n,97790)),"@site/examples/group-by/common/scalars/phone-number.mdx",97790],bff4d555:[()=>n.e(690).then(n.bind(n,32033)),"@site/api/printer-legacy/graphql/union.md",32033],c111dde1:[()=>n.e(2227).then(n.bind(n,79229)),"@site/examples/default/types/objects/user-format-statistic.mdx",79229],c1409486:[()=>n.e(7342).then(n.bind(n,53728)),"@site/examples/default/types/objects/user-stats.mdx",53728],c14b7bba:[()=>n.e(637).then(n.bind(n,37820)),"@site/api/utils/array.md",37820],c22eb062:[()=>n.e(9029).then(n.bind(n,86476)),"@site/examples/default/types/objects/user-tag-statistic.mdx",86476],c24a6c53:[()=>n.e(1356).then(n.bind(n,88231)),"@site/examples/default/types/enums/likeable-type.mdx",88231],c2c4f201:[()=>n.e(6584).then(n.bind(n,57290)),"@site/examples/default/types/enums/media-trend-sort.mdx",57290],c3f09d89:[()=>n.e(929).then(n.bind(n,15862)),"@site/examples/default/types/objects/user-studio-statistic.mdx",15862],c4770cc6:[()=>n.e(2160).then(n.bind(n,47514)),"@site/examples/default/types/objects/media-external-link.mdx",47514],c49f35ad:[()=>n.e(6152).then(n.bind(n,82076)),"@site/api/helpers/directives/tag.md",82076],c4f5d8e4:[()=>Promise.all([n.e(1869),n.e(2634)]).then(n.bind(n,12047)),"@site/src/pages/index.js",12047],c63ade1a:[()=>n.e(6947).then(n.bind(n,69861)),"@site/examples/group-by/course/queries/all-courses.mdx",69861],c76dab9c:[()=>n.e(898).then(n.bind(n,53944)),"@site/api/utils/url.md",53944],c8bbd86b:[()=>n.e(8218).then(n.bind(n,67292)),"@site/examples/default/types/objects/staff-submission.mdx",67292],c8d34300:[()=>n.e(5162).then(n.bind(n,63678)),"@site/examples/group-by/course/queries/course.mdx",63678],c9e0ef9e:[()=>n.e(175).then(n.bind(n,57705)),"@site/examples/default/api/queries/markdown.mdx",57705],ca15cc85:[()=>n.e(4746).then(n.bind(n,26404)),"@site/examples/default/types/enums/airing-sort.mdx",26404],ca6c7616:[()=>n.e(128).then(n.bind(n,20818)),"@site/examples/default/api/mutations/delete-review.mdx",20818],cb0f12d1:[()=>n.e(3902).then(n.bind(n,72609)),"@site/docs/advanced/custom-root-types.md",72609],cbb9af49:[()=>n.e(8583).then(n.bind(n,75782)),"@site/examples/group-by/deprecated/course/queries/math-courses.mdx",75782],cc64631c:[()=>n.e(9722).then(n.bind(n,99734)),"@site/examples/default/types/objects/user-score-statistic.mdx",99734],cfa185e8:[()=>n.e(3524).then(n.bind(n,40162)),"@site/examples/default/api/mutations/toggle-activity-subscription.mdx",40162],d0b8a394:[()=>n.e(2558).then(n.bind(n,56692)),"@site/examples/default/types/objects/thread-comment-subscribed-notification.mdx",56692],d262eff2:[()=>n.e(7296).then(n.bind(n,7510)),"@site/api/printer-legacy/graphql/input.md",7510],d2ed3302:[()=>n.e(1682).then(n.bind(n,26823)),"@site/docs/try-it.md",26823],d3adc8f8:[()=>n.e(4672).then(n.bind(n,25417)),"@site/examples/default/types/objects/page-info.mdx",25417],d41645b6:[()=>n.e(5047).then(n.bind(n,59173)),"@site/examples/default/api/queries/airing-schedule.mdx",59173],d418cbca:[()=>n.e(6323).then(n.bind(n,57058)),"@site/examples/default/types/unions/notification-union.mdx",57058],d53a6132:[()=>n.e(130).then(n.bind(n,60361)),"@site/examples/group-by/common/scalars/email-address.mdx",60361],d565c98c:[()=>n.e(5026).then(n.bind(n,65935)),"@site/examples/group-by/common/directives/one-of.mdx",65935],d56b581c:[()=>n.e(9489).then(n.bind(n,15517)),"@site/api/printer-legacy/graphql/enum.md",15517],d6f94056:[()=>n.e(9691).then(n.bind(n,37960)),"@site/examples/default/types/enums/media-type.mdx",37960],da360fa0:[()=>n.e(924).then(n.bind(n,97696)),"@site/api/utils/string.md",97696],dab33d80:[()=>n.e(8518).then(n.bind(n,41971)),"@site/examples/default/types/objects/thread-like-notification.mdx",41971],dc32cde7:[()=>n.e(6494).then(n.bind(n,11821)),"@site/examples/default/types/objects/activity-mention-notification.mdx",11821],deb1d2a7:[()=>n.e(5331).then(n.bind(n,63087)),"@site/examples/default/types/objects/staff-edge.mdx",63087],dec09136:[()=>n.e(1718).then(n.bind(n,74143)),"@site/docs/settings.md",74143],dee4a977:[()=>n.e(3505).then(n.bind(n,17231)),"@site/examples/default/types/objects/favourites.mdx",17231],df519fa4:[()=>n.e(5121).then(n.t.bind(n,93189,19)),"~docs/example-default/version-current-metadata-prop-751.json",93189],e0982400:[()=>n.e(5797).then(n.bind(n,11419)),"@site/examples/default/types/enums/score-format.mdx",11419],e1117e7c:[()=>n.e(2161).then(n.bind(n,75348)),"@site/examples/default/types/objects/site-trend-edge.mdx",75348],e1176882:[()=>n.e(426).then(n.bind(n,79e3)),"@site/examples/default/api/queries/genre-collection.mdx",79e3],e119c48e:[()=>n.e(9259).then(n.bind(n,34203)),"@site/examples/default/types/objects/character-submission-edge.mdx",34203],e15f1a31:[()=>n.e(9554).then(n.t.bind(n,61697,19)),"~docs/api/category-api-defaultsidebar-category-graphql-markdownlogger-ab8.json",61697],e16884a3:[()=>n.e(5555).then(n.bind(n,81700)),"@site/api/graphql/directive.md",81700],e2f266bc:[()=>n.e(6843).then(n.bind(n,59943)),"@site/examples/default/types/enums/recommendation-sort.mdx",59943],e3c712fc:[()=>n.e(9805).then(n.bind(n,90552)),"@site/examples/default/api/mutations/save-thread-comment.mdx",90552],e3e63689:[()=>n.e(6800).then(n.bind(n,84628)),"@site/api/printer-legacy/graphql/scalar.md",84628],e47ee25b:[()=>n.e(3160).then(n.bind(n,71342)),"@site/api/graphql/loader.md",71342],e57e108c:[()=>n.e(8129).then(n.bind(n,51572)),"@site/examples/default/api/queries/viewer.mdx",51572],e65c0bfb:[()=>n.e(4815).then(n.t.bind(n,12427,19)),"~docs/example-group-by/category-examplesgroup-by-schemasidebar-category-queries-overview-2-fc2.json",12427],e66bc7b1:[()=>n.e(315).then(n.bind(n,57417)),"@site/examples/default/types/objects/character-connection.mdx",57417],e7f041fd:[()=>Promise.all([n.e(1869),n.e(7746)]).then(n.bind(n,89010)),"@site/examples/default/anilist.md",89010],e85074cc:[()=>n.e(7980).then(n.bind(n,37166)),"@site/examples/default/api/mutations/delete-activity-reply.mdx",37166],e907509f:[()=>n.e(4212).then(n.bind(n,93700)),"@site/examples/default/api/queries/follower.mdx",93700],e91957f5:[()=>n.e(8332).then(n.bind(n,23322)),"@site/examples/default/types/enums/revision-history-action.mdx",23322],e9540e45:[()=>n.e(7514).then(n.bind(n,71001)),"@site/api/graphql/relation.md",71001],e9ade8ea:[()=>n.e(7443).then(n.bind(n,31700)),"@site/examples/default/types/objects/parsed-markdown.mdx",31700],ea584d1c:[()=>n.e(9256).then(n.bind(n,93331)),"@site/examples/default/api/mutations/rate-review.mdx",93331],eb4a6c9f:[()=>n.e(5531).then(n.bind(n,80519)),"@site/api/printer-legacy/badge.md",80519],eb87f8a5:[()=>n.e(9949).then(n.bind(n,48636)),"@site/examples/group-by/common/enums/roles.mdx",48636],eb8fe1c7:[()=>n.e(4776).then(n.bind(n,15801)),"@site/examples/default/types/objects/media-data-change-notification.mdx",15801],ecc1d182:[()=>n.e(432).then(n.bind(n,29929)),"@site/examples/default/types/objects/airing-progression.mdx",29929],edb2dccd:[()=>n.e(2502).then(n.bind(n,35997)),"@site/api/types/globals.md",35997],edc43b20:[()=>n.e(4084).then(n.bind(n,16286)),"@site/api/core/generator.md",16286],edca552c:[()=>n.e(9227).then(n.bind(n,41722)),"@site/examples/default/types/objects/user-avatar.mdx",41722],ee9d1b93:[()=>n.e(4707).then(n.bind(n,97138)),"@site/examples/default/api/queries/thread-comment.mdx",97138],eeaab8eb:[()=>n.e(4144).then(n.bind(n,43122)),"@site/examples/default/api/mutations/update-media-list-entries.mdx",43122],f00b26fb:[()=>n.e(8771).then(n.bind(n,56561)),"@site/examples/group-by/common/directives/include.mdx",56561],f1444194:[()=>n.e(3800).then(n.bind(n,37144)),"@site/examples/default/api/mutations/save-list-activity.mdx",37144],f1d92431:[()=>n.e(9887).then(n.bind(n,94234)),"@site/examples/default/types/enums/staff-sort.mdx",94234],f29e0ecd:[()=>n.e(4117).then(n.bind(n,54336)),"@site/examples/default/types/objects/media-tag.mdx",54336],f35cfef6:[()=>n.e(6917).then(n.bind(n,35206)),"@site/examples/default/types/objects/internal-page.mdx",35206],f4295948:[()=>n.e(4168).then(n.bind(n,68225)),"@site/examples/default/types/enums/media-rank-type.mdx",68225],f44337a2:[()=>n.e(9593).then(n.bind(n,51275)),"@site/api/diff/globals.md",51275],f4e6c3c2:[()=>n.e(3197).then(n.t.bind(n,56150,19)),"~docs/api/category-api-defaultsidebar-category-directives-74d.json",56150],f6e8bb3b:[()=>n.e(71).then(n.bind(n,68515)),"@site/api/core/printer.md",68515],f7838618:[()=>n.e(3216).then(n.bind(n,44023)),"@site/examples/default/api/mutations/toggle-thread-subscription.mdx",44023],f82d8ab1:[()=>n.e(8553).then(n.bind(n,72076)),"@site/examples/default/types/inputs/character-name-input.mdx",72076],f851f38c:[()=>n.e(237).then(n.bind(n,75394)),"@site/examples/default/types/enums/studio-sort.mdx",75394],f86c5306:[()=>n.e(3542).then(n.bind(n,36079)),"@site/examples/default/api/mutations/save-text-activity.mdx",36079],f8996f50:[()=>n.e(200).then(n.bind(n,11564)),"@site/examples/default/types/objects/thread-comment-mention-notification.mdx",11564],fa15202c:[()=>n.e(2437).then(n.bind(n,96941)),"@site/examples/default/types/objects/review-edge.mdx",96941],fb04d2c3:[()=>n.e(7307).then(n.bind(n,70202)),"@site/examples/default/types/objects/thread-comment-reply-notification.mdx",70202],fc392f2f:[()=>n.e(8910).then(n.bind(n,94267)),"@site/examples/default/types/enums/media-list-sort.mdx",94267],fd28e8ce:[()=>n.e(1844).then(n.bind(n,36626)),"@site/examples/default/types/unions/likeable-union.mdx",36626],fd5696d2:[()=>n.e(9603).then(n.bind(n,55316)),"@site/examples/default/types/objects/user-statistics.mdx",55316],fd6fac8d:[()=>n.e(69).then(n.t.bind(n,30209,19)),"/graphql-markdown/.docusaurus/docusaurus-plugin-content-docs/example-group-by/plugin-route-context-module-100.json",30209],fda7d2b0:[()=>n.e(5945).then(n.t.bind(n,42065,19)),"~docs/api/category-api-defaultsidebar-category-graphql-markdowncore-bf6.json",42065],ffc18f74:[()=>n.e(1700).then(n.bind(n,13147)),"@site/examples/default/types/objects/airing-notification.mdx",13147],ffde7875:[()=>n.e(5667).then(n.bind(n,96275)),"@site/examples/group-by/grade/queries/weighted-gpa.mdx",96275]};var s=n(74848);function l(e){let{error:t,retry:n,pastDelay:a}=e;return t?(0,s.jsxs)("div",{style:{textAlign:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"},children:[(0,s.jsx)("p",{children:String(t)}),(0,s.jsx)("div",{children:(0,s.jsx)("button",{type:"button",onClick:n,children:"Retry"})})]}):a?(0,s.jsx)("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"},children:(0,s.jsx)("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb",children:(0,s.jsxs)("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2",children:[(0,s.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,s.jsx)("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,s.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,s.jsx)("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,s.jsx)("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,s.jsx)("circle",{cx:"22",cy:"22",r:"8",children:(0,s.jsx)("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"})})]})})}):null}var c=n(81604),u=n(23363);function d(e,t){if("*"===e)return r()({loading:l,loader:()=>n.e(2560).then(n.bind(n,72560)),modules:["@theme/NotFound"],webpack:()=>[72560],render(e,t){const n=e.default;return(0,s.jsx)(u.W,{value:{plugin:{name:"native",id:"default"}},children:(0,s.jsx)(n,{...t})})}});const a=i[`${e}-${t}`],d={},p=[],m=[],f=(0,c.A)(a);return Object.entries(f).forEach((e=>{let[t,n]=e;const a=o[n];a&&(d[t]=a[0],p.push(a[1]),m.push(a[2]))})),r().Map({loading:l,loader:d,modules:p,webpack:()=>m,render(t,n){const r=JSON.parse(JSON.stringify(a));Object.entries(t).forEach((t=>{let[n,a]=t;const i=a.default;if(!i)throw new Error(`The page component at ${e} doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.`);"object"!=typeof i&&"function"!=typeof i||Object.keys(a).filter((e=>"default"!==e)).forEach((e=>{i[e]=a[e]}));let o=r;const s=n.split(".");s.slice(0,-1).forEach((e=>{o=o[e]})),o[s[s.length-1]]=i}));const i=r.__comp;delete r.__comp;const o=r.__context;return delete r.__context,(0,s.jsx)(u.W,{value:o,children:(0,s.jsx)(i,{...r,...n})})}})}const p=[{path:"/api",component:d("/api","708"),routes:[{path:"/api",component:d("/api","233"),routes:[{path:"/api",component:d("/api","78c"),routes:[{path:"/api/",component:d("/api/","560"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/category/const",component:d("/api/category/const","580"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/category/directives",component:d("/api/category/directives","ac1"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/category/graphql",component:d("/api/category/graphql","e4e"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/category/graphql-markdowncore",component:d("/api/category/graphql-markdowncore","413"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/category/graphql-markdowndiff",component:d("/api/category/graphql-markdowndiff","1a0"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/category/graphql-markdowndocusaurus",component:d("/api/category/graphql-markdowndocusaurus","c55"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/category/graphql-markdowngraphql",component:d("/api/category/graphql-markdowngraphql","7ea"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/category/graphql-markdownhelpers",component:d("/api/category/graphql-markdownhelpers","41b"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/category/graphql-markdownlogger",component:d("/api/category/graphql-markdownlogger","6ff"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/category/graphql-markdownprinter-legacy",component:d("/api/category/graphql-markdownprinter-legacy","c90"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/category/graphql-markdowntypes",component:d("/api/category/graphql-markdowntypes","151"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/category/graphql-markdownutils",component:d("/api/category/graphql-markdownutils","f17"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/category/utils",component:d("/api/category/utils","4e2"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/core/config",component:d("/api/core/config","255"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/core/diff",component:d("/api/core/diff","54c"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/core/generator",component:d("/api/core/generator","2f1"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/core/graphql-config",component:d("/api/core/graphql-config","f5e"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/core/printer",component:d("/api/core/printer","a40"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/core/renderer",component:d("/api/core/renderer","43e"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/diff/globals",component:d("/api/diff/globals","873"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/docusaurus/globals",component:d("/api/docusaurus/globals","8cf"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/graphql/directive",component:d("/api/graphql/directive","3d8"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/graphql/formatter",component:d("/api/graphql/formatter","e01"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/graphql/group",component:d("/api/graphql/group","b97"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/graphql/guard",component:d("/api/graphql/guard","586"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/graphql/introspection",component:d("/api/graphql/introspection","4a0"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/graphql/loader",component:d("/api/graphql/loader","cd0"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/graphql/relation",component:d("/api/graphql/relation","488"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/helpers/directives/descriptor",component:d("/api/helpers/directives/descriptor","18f"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/helpers/directives/tag",component:d("/api/helpers/directives/tag","819"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/helpers/utils/interpolate",component:d("/api/helpers/utils/interpolate","9c6"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/logger/globals",component:d("/api/logger/globals","3ae"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/badge",component:d("/api/printer-legacy/badge","27f"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/code",component:d("/api/printer-legacy/code","de0"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/common",component:d("/api/printer-legacy/common","332"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/const/mdx",component:d("/api/printer-legacy/const/mdx","ede"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/const/options",component:d("/api/printer-legacy/const/options","19f"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/const/strings",component:d("/api/printer-legacy/const/strings","a8d"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/directive",component:d("/api/printer-legacy/directive","63d"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/example",component:d("/api/printer-legacy/example","3cc"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/frontmatter",component:d("/api/printer-legacy/frontmatter","18d"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/graphql/directive",component:d("/api/printer-legacy/graphql/directive","780"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/graphql/enum",component:d("/api/printer-legacy/graphql/enum","477"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/graphql/input",component:d("/api/printer-legacy/graphql/input","231"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/graphql/interface",component:d("/api/printer-legacy/graphql/interface","4c0"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/graphql/object",component:d("/api/printer-legacy/graphql/object","558"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/graphql/operation",component:d("/api/printer-legacy/graphql/operation","beb"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/graphql/scalar",component:d("/api/printer-legacy/graphql/scalar","a2d"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/graphql/union",component:d("/api/printer-legacy/graphql/union","8bd"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/group",component:d("/api/printer-legacy/group","dfb"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/link",component:d("/api/printer-legacy/link","000"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/printer",component:d("/api/printer-legacy/printer","ce5"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/relation",component:d("/api/printer-legacy/relation","723"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/printer-legacy/section",component:d("/api/printer-legacy/section","ad3"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/types/globals",component:d("/api/types/globals","c42"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/utils/array",component:d("/api/utils/array","b9a"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/utils/fs",component:d("/api/utils/fs","bfe"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/utils/object",component:d("/api/utils/object","916"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/utils/prettier",component:d("/api/utils/prettier","353"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/utils/string",component:d("/api/utils/string","3eb"),exact:!0,sidebar:"defaultSidebar"},{path:"/api/utils/url",component:d("/api/utils/url","dc0"),exact:!0,sidebar:"defaultSidebar"}]}]}]},{path:"/docs",component:d("/docs","a58"),routes:[{path:"/docs",component:d("/docs","a2b"),routes:[{path:"/docs",component:d("/docs","ccc"),routes:[{path:"/docs/advanced/additional-schema",component:d("/docs/advanced/additional-schema","032"),exact:!0,sidebar:"defaultSidebar"},{path:"/docs/advanced/custom-deprecated-section",component:d("/docs/advanced/custom-deprecated-section","98e"),exact:!0,sidebar:"defaultSidebar"},{path:"/docs/advanced/custom-directive",component:d("/docs/advanced/custom-directive","6e2"),exact:!0,sidebar:"defaultSidebar"},{path:"/docs/advanced/custom-root-types",component:d("/docs/advanced/custom-root-types","ed1"),exact:!0,sidebar:"defaultSidebar"},{path:"/docs/advanced/docs-multi-instance",component:d("/docs/advanced/docs-multi-instance","ed2"),exact:!0,sidebar:"defaultSidebar"},{path:"/docs/advanced/examples",component:d("/docs/advanced/examples","b6a"),exact:!0,sidebar:"defaultSidebar"},{path:"/docs/advanced/group-by-directive",component:d("/docs/advanced/group-by-directive","492"),exact:!0,sidebar:"defaultSidebar"},{path:"/docs/advanced/homepage",component:d("/docs/advanced/homepage","b0c"),exact:!0,sidebar:"defaultSidebar"},{path:"/docs/advanced/schema-loading",component:d("/docs/advanced/schema-loading","cac"),exact:!0,sidebar:"defaultSidebar"},{path:"/docs/category/advanced-settings",component:d("/docs/category/advanced-settings","3a6"),exact:!0,sidebar:"defaultSidebar"},{path:"/docs/configuration",component:d("/docs/configuration","117"),exact:!0,sidebar:"defaultSidebar"},{path:"/docs/get-started",component:d("/docs/get-started","26f"),exact:!0,sidebar:"defaultSidebar"},{path:"/docs/intro",component:d("/docs/intro","5ba"),exact:!0,sidebar:"defaultSidebar"},{path:"/docs/settings",component:d("/docs/settings","76b"),exact:!0,sidebar:"defaultSidebar"},{path:"/docs/troubleshooting",component:d("/docs/troubleshooting","449"),exact:!0,sidebar:"defaultSidebar"},{path:"/docs/try-it",component:d("/docs/try-it","0b5"),exact:!0,sidebar:"defaultSidebar"}]}]}]},{path:"/examples/default",component:d("/examples/default","88b"),routes:[{path:"/examples/default",component:d("/examples/default","268"),routes:[{path:"/examples/default",component:d("/examples/default","30e"),routes:[{path:"/examples/default/",component:d("/examples/default/","4e5"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/directives/include",component:d("/examples/default/api/directives/include","2b0"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/directives/skip",component:d("/examples/default/api/directives/skip","585"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/delete-activity",component:d("/examples/default/api/mutations/delete-activity","d67"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/delete-activity-reply",component:d("/examples/default/api/mutations/delete-activity-reply","0e1"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/delete-custom-list",component:d("/examples/default/api/mutations/delete-custom-list","870"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/delete-media-list-entry",component:d("/examples/default/api/mutations/delete-media-list-entry","5e2"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/delete-review",component:d("/examples/default/api/mutations/delete-review","f31"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/delete-thread",component:d("/examples/default/api/mutations/delete-thread","00a"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/delete-thread-comment",component:d("/examples/default/api/mutations/delete-thread-comment","ceb"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/rate-review",component:d("/examples/default/api/mutations/rate-review","3a6"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/save-activity-reply",component:d("/examples/default/api/mutations/save-activity-reply","d85"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/save-list-activity",component:d("/examples/default/api/mutations/save-list-activity","21c"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/save-media-list-entry",component:d("/examples/default/api/mutations/save-media-list-entry","8b9"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/save-message-activity",component:d("/examples/default/api/mutations/save-message-activity","762"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/save-recommendation",component:d("/examples/default/api/mutations/save-recommendation","2ea"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/save-review",component:d("/examples/default/api/mutations/save-review","827"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/save-text-activity",component:d("/examples/default/api/mutations/save-text-activity","594"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/save-thread",component:d("/examples/default/api/mutations/save-thread","f9b"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/save-thread-comment",component:d("/examples/default/api/mutations/save-thread-comment","2f6"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/toggle-activity-pin",component:d("/examples/default/api/mutations/toggle-activity-pin","880"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/toggle-activity-subscription",component:d("/examples/default/api/mutations/toggle-activity-subscription","0ca"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/toggle-favourite",component:d("/examples/default/api/mutations/toggle-favourite","dce"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/toggle-follow",component:d("/examples/default/api/mutations/toggle-follow","4bc"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/toggle-like",component:d("/examples/default/api/mutations/toggle-like","7ed"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/toggle-like-v2",component:d("/examples/default/api/mutations/toggle-like-v2","7e0"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/toggle-thread-subscription",component:d("/examples/default/api/mutations/toggle-thread-subscription","b46"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/update-ani-chart-highlights",component:d("/examples/default/api/mutations/update-ani-chart-highlights","bc3"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/update-ani-chart-settings",component:d("/examples/default/api/mutations/update-ani-chart-settings","d7f"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/update-favourite-order",component:d("/examples/default/api/mutations/update-favourite-order","2b4"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/update-media-list-entries",component:d("/examples/default/api/mutations/update-media-list-entries","437"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/mutations/update-user",component:d("/examples/default/api/mutations/update-user","0f6"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/activity",component:d("/examples/default/api/queries/activity","6dc"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/activity-reply",component:d("/examples/default/api/queries/activity-reply","072"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/airing-schedule",component:d("/examples/default/api/queries/airing-schedule","f54"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/ani-chart-user",component:d("/examples/default/api/queries/ani-chart-user","81a"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/character",component:d("/examples/default/api/queries/character","a5a"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/external-link-source-collection",component:d("/examples/default/api/queries/external-link-source-collection","621"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/follower",component:d("/examples/default/api/queries/follower","9c2"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/following",component:d("/examples/default/api/queries/following","027"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/genre-collection",component:d("/examples/default/api/queries/genre-collection","929"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/like",component:d("/examples/default/api/queries/like","8c2"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/markdown",component:d("/examples/default/api/queries/markdown","267"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/media",component:d("/examples/default/api/queries/media","751"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/media-list",component:d("/examples/default/api/queries/media-list","0a1"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/media-list-collection",component:d("/examples/default/api/queries/media-list-collection","5ab"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/media-tag-collection",component:d("/examples/default/api/queries/media-tag-collection","4de"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/media-trend",component:d("/examples/default/api/queries/media-trend","4f6"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/notification",component:d("/examples/default/api/queries/notification","8e7"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/page",component:d("/examples/default/api/queries/page","951"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/recommendation",component:d("/examples/default/api/queries/recommendation","ef8"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/review",component:d("/examples/default/api/queries/review","cb7"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/site-statistics",component:d("/examples/default/api/queries/site-statistics","2ca"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/staff",component:d("/examples/default/api/queries/staff","730"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/studio",component:d("/examples/default/api/queries/studio","714"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/thread",component:d("/examples/default/api/queries/thread","e97"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/thread-comment",component:d("/examples/default/api/queries/thread-comment","026"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/user",component:d("/examples/default/api/queries/user","f58"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/api/queries/viewer",component:d("/examples/default/api/queries/viewer","258"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/directives/deprecated",component:d("/examples/default/types/directives/deprecated","fc0"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/activity-sort",component:d("/examples/default/types/enums/activity-sort","62d"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/activity-type",component:d("/examples/default/types/enums/activity-type","292"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/airing-sort",component:d("/examples/default/types/enums/airing-sort","442"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/character-role",component:d("/examples/default/types/enums/character-role","6cf"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/character-sort",component:d("/examples/default/types/enums/character-sort","96a"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/external-link-media-type",component:d("/examples/default/types/enums/external-link-media-type","35a"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/external-link-type",component:d("/examples/default/types/enums/external-link-type","b8c"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/likeable-type",component:d("/examples/default/types/enums/likeable-type","9ac"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/media-format",component:d("/examples/default/types/enums/media-format","7eb"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/media-list-sort",component:d("/examples/default/types/enums/media-list-sort","7c1"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/media-list-status",component:d("/examples/default/types/enums/media-list-status","e10"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/media-rank-type",component:d("/examples/default/types/enums/media-rank-type","c74"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/media-relation",component:d("/examples/default/types/enums/media-relation","78e"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/media-season",component:d("/examples/default/types/enums/media-season","b54"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/media-sort",component:d("/examples/default/types/enums/media-sort","489"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/media-source",component:d("/examples/default/types/enums/media-source","594"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/media-status",component:d("/examples/default/types/enums/media-status","352"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/media-trend-sort",component:d("/examples/default/types/enums/media-trend-sort","e4d"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/media-type",component:d("/examples/default/types/enums/media-type","a63"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/mod-action-type",component:d("/examples/default/types/enums/mod-action-type","7bf"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/mod-role",component:d("/examples/default/types/enums/mod-role","7d6"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/notification-type",component:d("/examples/default/types/enums/notification-type","ac4"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/recommendation-rating",component:d("/examples/default/types/enums/recommendation-rating","479"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/recommendation-sort",component:d("/examples/default/types/enums/recommendation-sort","ef7"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/review-rating",component:d("/examples/default/types/enums/review-rating","616"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/review-sort",component:d("/examples/default/types/enums/review-sort","7ef"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/revision-history-action",component:d("/examples/default/types/enums/revision-history-action","6b5"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/score-format",component:d("/examples/default/types/enums/score-format","4a3"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/site-trend-sort",component:d("/examples/default/types/enums/site-trend-sort","b6e"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/staff-language",component:d("/examples/default/types/enums/staff-language","64e"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/staff-sort",component:d("/examples/default/types/enums/staff-sort","36a"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/studio-sort",component:d("/examples/default/types/enums/studio-sort","d7c"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/submission-sort",component:d("/examples/default/types/enums/submission-sort","0a3"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/submission-status",component:d("/examples/default/types/enums/submission-status","8d6"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/thread-comment-sort",component:d("/examples/default/types/enums/thread-comment-sort","9ed"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/thread-sort",component:d("/examples/default/types/enums/thread-sort","333"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/user-sort",component:d("/examples/default/types/enums/user-sort","db7"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/user-staff-name-language",component:d("/examples/default/types/enums/user-staff-name-language","a74"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/user-statistics-sort",component:d("/examples/default/types/enums/user-statistics-sort","08c"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/enums/user-title-language",component:d("/examples/default/types/enums/user-title-language","ff3"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/inputs/airing-schedule-input",component:d("/examples/default/types/inputs/airing-schedule-input","a20"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/inputs/ani-chart-highlight-input",component:d("/examples/default/types/inputs/ani-chart-highlight-input","9b5"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/inputs/character-name-input",component:d("/examples/default/types/inputs/character-name-input","e69"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/inputs/fuzzy-date-input",component:d("/examples/default/types/inputs/fuzzy-date-input","899"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/inputs/list-activity-option-input",component:d("/examples/default/types/inputs/list-activity-option-input","120"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/inputs/media-external-link-input",component:d("/examples/default/types/inputs/media-external-link-input","b7f"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/inputs/media-list-options-input",component:d("/examples/default/types/inputs/media-list-options-input","24d"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/inputs/media-title-input",component:d("/examples/default/types/inputs/media-title-input","d36"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/inputs/notification-option-input",component:d("/examples/default/types/inputs/notification-option-input","f3d"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/inputs/staff-name-input",component:d("/examples/default/types/inputs/staff-name-input","824"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/activity-like-notification",component:d("/examples/default/types/objects/activity-like-notification","d36"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/activity-mention-notification",component:d("/examples/default/types/objects/activity-mention-notification","9b9"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/activity-message-notification",component:d("/examples/default/types/objects/activity-message-notification","672"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/activity-reply",component:d("/examples/default/types/objects/activity-reply","ca8"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/activity-reply-like-notification",component:d("/examples/default/types/objects/activity-reply-like-notification","b7a"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/activity-reply-notification",component:d("/examples/default/types/objects/activity-reply-notification","776"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/activity-reply-subscribed-notification",component:d("/examples/default/types/objects/activity-reply-subscribed-notification","547"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/airing-notification",component:d("/examples/default/types/objects/airing-notification","317"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/airing-progression",component:d("/examples/default/types/objects/airing-progression","83f"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/airing-schedule",component:d("/examples/default/types/objects/airing-schedule","2ce"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/airing-schedule-connection",component:d("/examples/default/types/objects/airing-schedule-connection","e9e"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/airing-schedule-edge",component:d("/examples/default/types/objects/airing-schedule-edge","540"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/ani-chart-user",component:d("/examples/default/types/objects/ani-chart-user","838"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/character",component:d("/examples/default/types/objects/character","9d5"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/character-connection",component:d("/examples/default/types/objects/character-connection","30e"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/character-edge",component:d("/examples/default/types/objects/character-edge","8fe"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/character-image",component:d("/examples/default/types/objects/character-image","85b"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/character-name",component:d("/examples/default/types/objects/character-name","7e3"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/character-submission",component:d("/examples/default/types/objects/character-submission","815"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/character-submission-connection",component:d("/examples/default/types/objects/character-submission-connection","11c"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/character-submission-edge",component:d("/examples/default/types/objects/character-submission-edge","1c5"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/deleted",component:d("/examples/default/types/objects/deleted","943"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/favourites",component:d("/examples/default/types/objects/favourites","338"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/following-notification",component:d("/examples/default/types/objects/following-notification","62e"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/format-stats",component:d("/examples/default/types/objects/format-stats","cb7"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/fuzzy-date",component:d("/examples/default/types/objects/fuzzy-date","6f8"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/genre-stats",component:d("/examples/default/types/objects/genre-stats","c2c"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/internal-page",component:d("/examples/default/types/objects/internal-page","410"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/list-activity",component:d("/examples/default/types/objects/list-activity","ed5"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/list-activity-option",component:d("/examples/default/types/objects/list-activity-option","2c5"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/list-score-stats",component:d("/examples/default/types/objects/list-score-stats","13e"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media",component:d("/examples/default/types/objects/media","fdf"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-character",component:d("/examples/default/types/objects/media-character","5fe"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-connection",component:d("/examples/default/types/objects/media-connection","302"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-cover-image",component:d("/examples/default/types/objects/media-cover-image","57e"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-data-change-notification",component:d("/examples/default/types/objects/media-data-change-notification","e8f"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-deletion-notification",component:d("/examples/default/types/objects/media-deletion-notification","72a"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-edge",component:d("/examples/default/types/objects/media-edge","2ef"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-external-link",component:d("/examples/default/types/objects/media-external-link","24c"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-list",component:d("/examples/default/types/objects/media-list","e42"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-list-collection",component:d("/examples/default/types/objects/media-list-collection","81e"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-list-group",component:d("/examples/default/types/objects/media-list-group","eb7"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-list-options",component:d("/examples/default/types/objects/media-list-options","d64"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-list-type-options",component:d("/examples/default/types/objects/media-list-type-options","3fb"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-merge-notification",component:d("/examples/default/types/objects/media-merge-notification","fbb"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-rank",component:d("/examples/default/types/objects/media-rank","01d"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-stats",component:d("/examples/default/types/objects/media-stats","32e"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-streaming-episode",component:d("/examples/default/types/objects/media-streaming-episode","82e"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-submission",component:d("/examples/default/types/objects/media-submission","533"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-submission-comparison",component:d("/examples/default/types/objects/media-submission-comparison","cb9"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-submission-edge",component:d("/examples/default/types/objects/media-submission-edge","0e3"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-tag",component:d("/examples/default/types/objects/media-tag","f5c"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-title",component:d("/examples/default/types/objects/media-title","237"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-trailer",component:d("/examples/default/types/objects/media-trailer","9a2"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-trend",component:d("/examples/default/types/objects/media-trend","1df"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-trend-connection",component:d("/examples/default/types/objects/media-trend-connection","417"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/media-trend-edge",component:d("/examples/default/types/objects/media-trend-edge","ff2"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/message-activity",component:d("/examples/default/types/objects/message-activity","29e"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/mod-action",component:d("/examples/default/types/objects/mod-action","1b1"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/notification-option",component:d("/examples/default/types/objects/notification-option","1a7"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/page",component:d("/examples/default/types/objects/page","e5b"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/page-info",component:d("/examples/default/types/objects/page-info","1b4"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/parsed-markdown",component:d("/examples/default/types/objects/parsed-markdown","970"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/recommendation",component:d("/examples/default/types/objects/recommendation","b60"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/recommendation-connection",component:d("/examples/default/types/objects/recommendation-connection","ced"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/recommendation-edge",component:d("/examples/default/types/objects/recommendation-edge","17c"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/related-media-addition-notification",component:d("/examples/default/types/objects/related-media-addition-notification","254"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/report",component:d("/examples/default/types/objects/report","467"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/review",component:d("/examples/default/types/objects/review","350"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/review-connection",component:d("/examples/default/types/objects/review-connection","92d"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/review-edge",component:d("/examples/default/types/objects/review-edge","4e4"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/revision-history",component:d("/examples/default/types/objects/revision-history","49c"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/score-distribution",component:d("/examples/default/types/objects/score-distribution","d16"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/site-statistics",component:d("/examples/default/types/objects/site-statistics","375"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/site-trend",component:d("/examples/default/types/objects/site-trend","594"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/site-trend-connection",component:d("/examples/default/types/objects/site-trend-connection","02a"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/site-trend-edge",component:d("/examples/default/types/objects/site-trend-edge","bb4"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/staff",component:d("/examples/default/types/objects/staff","967"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/staff-connection",component:d("/examples/default/types/objects/staff-connection","5e2"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/staff-edge",component:d("/examples/default/types/objects/staff-edge","822"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/staff-image",component:d("/examples/default/types/objects/staff-image","4f5"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/staff-name",component:d("/examples/default/types/objects/staff-name","9fb"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/staff-role-type",component:d("/examples/default/types/objects/staff-role-type","565"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/staff-stats",component:d("/examples/default/types/objects/staff-stats","344"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/staff-submission",component:d("/examples/default/types/objects/staff-submission","f51"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/status-distribution",component:d("/examples/default/types/objects/status-distribution","9f0"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/studio",component:d("/examples/default/types/objects/studio","f36"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/studio-connection",component:d("/examples/default/types/objects/studio-connection","505"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/studio-edge",component:d("/examples/default/types/objects/studio-edge","75a"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/studio-stats",component:d("/examples/default/types/objects/studio-stats","c00"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/tag-stats",component:d("/examples/default/types/objects/tag-stats","af4"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/text-activity",component:d("/examples/default/types/objects/text-activity","21a"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/thread",component:d("/examples/default/types/objects/thread","7ba"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/thread-category",component:d("/examples/default/types/objects/thread-category","bad"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/thread-comment",component:d("/examples/default/types/objects/thread-comment","873"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/thread-comment-like-notification",component:d("/examples/default/types/objects/thread-comment-like-notification","0ec"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/thread-comment-mention-notification",component:d("/examples/default/types/objects/thread-comment-mention-notification","a5a"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/thread-comment-reply-notification",component:d("/examples/default/types/objects/thread-comment-reply-notification","f50"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/thread-comment-subscribed-notification",component:d("/examples/default/types/objects/thread-comment-subscribed-notification","661"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/thread-like-notification",component:d("/examples/default/types/objects/thread-like-notification","f21"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/user",component:d("/examples/default/types/objects/user","30a"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/user-activity-history",component:d("/examples/default/types/objects/user-activity-history","f33"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/user-avatar",component:d("/examples/default/types/objects/user-avatar","e9d"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/user-country-statistic",component:d("/examples/default/types/objects/user-country-statistic","b74"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/user-format-statistic",component:d("/examples/default/types/objects/user-format-statistic","917"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/user-genre-statistic",component:d("/examples/default/types/objects/user-genre-statistic","6e5"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/user-length-statistic",component:d("/examples/default/types/objects/user-length-statistic","e2b"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/user-mod-data",component:d("/examples/default/types/objects/user-mod-data","7b9"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/user-options",component:d("/examples/default/types/objects/user-options","cda"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/user-previous-name",component:d("/examples/default/types/objects/user-previous-name","186"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/user-release-year-statistic",component:d("/examples/default/types/objects/user-release-year-statistic","abe"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/user-score-statistic",component:d("/examples/default/types/objects/user-score-statistic","57d"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/user-staff-statistic",component:d("/examples/default/types/objects/user-staff-statistic","c1b"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/user-start-year-statistic",component:d("/examples/default/types/objects/user-start-year-statistic","dfb"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/user-statistic-types",component:d("/examples/default/types/objects/user-statistic-types","46c"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/user-statistics",component:d("/examples/default/types/objects/user-statistics","a0d"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/user-stats",component:d("/examples/default/types/objects/user-stats","1ac"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/user-status-statistic",component:d("/examples/default/types/objects/user-status-statistic","fa7"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/user-studio-statistic",component:d("/examples/default/types/objects/user-studio-statistic","de3"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/user-tag-statistic",component:d("/examples/default/types/objects/user-tag-statistic","56f"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/user-voice-actor-statistic",component:d("/examples/default/types/objects/user-voice-actor-statistic","c68"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/objects/year-stats",component:d("/examples/default/types/objects/year-stats","464"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/scalars/boolean",component:d("/examples/default/types/scalars/boolean","cd5"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/scalars/country-code",component:d("/examples/default/types/scalars/country-code","949"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/scalars/float",component:d("/examples/default/types/scalars/float","d6f"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/scalars/fuzzy-date-int",component:d("/examples/default/types/scalars/fuzzy-date-int","a70"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/scalars/id",component:d("/examples/default/types/scalars/id","7b9"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/scalars/int",component:d("/examples/default/types/scalars/int","357"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/scalars/json",component:d("/examples/default/types/scalars/json","294"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/scalars/string",component:d("/examples/default/types/scalars/string","612"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/unions/activity-union",component:d("/examples/default/types/unions/activity-union","284"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/unions/likeable-union",component:d("/examples/default/types/unions/likeable-union","c93"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/default/types/unions/notification-union",component:d("/examples/default/types/unions/notification-union","baf"),exact:!0,sidebar:"schemaSidebar"}]}]}]},{path:"/examples/group-by",component:d("/examples/group-by","14f"),routes:[{path:"/examples/group-by",component:d("/examples/group-by","04b"),routes:[{path:"/examples/group-by",component:d("/examples/group-by","40b"),routes:[{path:"/examples/group-by/",component:d("/examples/group-by/","d30"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/category/common",component:d("/examples/group-by/category/common","c03"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/category/course",component:d("/examples/group-by/category/course","1cf"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/category/course-1",component:d("/examples/group-by/category/course-1","db1"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/category/deprecated",component:d("/examples/group-by/category/deprecated","0d8"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/category/directives",component:d("/examples/group-by/category/directives","969"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/category/enums",component:d("/examples/group-by/category/enums","933"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/category/grade",component:d("/examples/group-by/category/grade","559"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/category/interfaces",component:d("/examples/group-by/category/interfaces","05d"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/category/mutations",component:d("/examples/group-by/category/mutations","d65"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/category/mutations-1",component:d("/examples/group-by/category/mutations-1","b5a"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/category/objects",component:d("/examples/group-by/category/objects","44a"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/category/queries",component:d("/examples/group-by/category/queries","f4d"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/category/queries-1",component:d("/examples/group-by/category/queries-1","28e"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/category/queries-2",component:d("/examples/group-by/category/queries-2","506"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/category/queries-3",component:d("/examples/group-by/category/queries-3","c60"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/category/scalars",component:d("/examples/group-by/category/scalars","8dc"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/directives/auth",component:d("/examples/group-by/common/directives/auth","41b"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/directives/beta",component:d("/examples/group-by/common/directives/beta","c03"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/directives/complexity",component:d("/examples/group-by/common/directives/complexity","3b0"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/directives/deprecated",component:d("/examples/group-by/common/directives/deprecated","64c"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/directives/doc",component:d("/examples/group-by/common/directives/doc","705"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/directives/example",component:d("/examples/group-by/common/directives/example","861"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/directives/include",component:d("/examples/group-by/common/directives/include","f2c"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/directives/no-doc",component:d("/examples/group-by/common/directives/no-doc","4f5"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/directives/one-of",component:d("/examples/group-by/common/directives/one-of","f1a"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/directives/skip",component:d("/examples/group-by/common/directives/skip","6e4"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/directives/specified-by",component:d("/examples/group-by/common/directives/specified-by","d24"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/enums/roles",component:d("/examples/group-by/common/enums/roles","c90"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/interfaces/record",component:d("/examples/group-by/common/interfaces/record","532"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/objects/course",component:d("/examples/group-by/common/objects/course","b6c"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/objects/department-information",component:d("/examples/group-by/common/objects/department-information","1a6"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/objects/semester",component:d("/examples/group-by/common/objects/semester","9b9"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/queries/search-role",component:d("/examples/group-by/common/queries/search-role","381"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/scalars/boolean",component:d("/examples/group-by/common/scalars/boolean","cab"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/scalars/date",component:d("/examples/group-by/common/scalars/date","98c"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/scalars/email-address",component:d("/examples/group-by/common/scalars/email-address","c12"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/scalars/id",component:d("/examples/group-by/common/scalars/id","872"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/scalars/int",component:d("/examples/group-by/common/scalars/int","cd5"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/scalars/phone-number",component:d("/examples/group-by/common/scalars/phone-number","c72"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/scalars/string",component:d("/examples/group-by/common/scalars/string","73a"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/scalars/time",component:d("/examples/group-by/common/scalars/time","156"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/common/scalars/url",component:d("/examples/group-by/common/scalars/url","42e"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/course/mutations/add-course",component:d("/examples/group-by/course/mutations/add-course","6f1"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/course/mutations/drop-course",component:d("/examples/group-by/course/mutations/drop-course","583"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/course/queries/all-courses",component:d("/examples/group-by/course/queries/all-courses","bd6"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/course/queries/course",component:d("/examples/group-by/course/queries/course","430"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/deprecated/course/queries/math-courses",component:d("/examples/group-by/deprecated/course/queries/math-courses","d32"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/deprecated/course/queries/science-courses",component:d("/examples/group-by/deprecated/course/queries/science-courses","0af"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/grade/mutations/update-gpa",component:d("/examples/group-by/grade/mutations/update-gpa","fbb"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/grade/mutations/update-grade",component:d("/examples/group-by/grade/mutations/update-grade","831"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/grade/queries/gpa",component:d("/examples/group-by/grade/queries/gpa","064"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/grade/queries/un-weighted-gpa",component:d("/examples/group-by/grade/queries/un-weighted-gpa","fb5"),exact:!0,sidebar:"schemaSidebar"},{path:"/examples/group-by/grade/queries/weighted-gpa",component:d("/examples/group-by/grade/queries/weighted-gpa","fae"),exact:!0,sidebar:"schemaSidebar"}]}]}]},{path:"/",component:d("/","1d7"),exact:!0},{path:"*",component:d("*")}]},60774:(e,t,n)=>{var a,r;!function(){var i,o,s,l,c,u,d,p,m,f,h,b,y,g,v,x,w,S,_,k,j,E,O,C,P,A,T,I,N,R,L=function(e){var t=new L.Builder;return t.pipeline.add(L.trimmer,L.stopWordFilter,L.stemmer),t.searchPipeline.add(L.stemmer),e.call(t,t),t.build()};L.version="2.3.9",L.utils={},L.utils.warn=(i=this,function(e){i.console&&console.warn&&console.warn(e)}),L.utils.asString=function(e){return null==e?"":e.toString()},L.utils.clone=function(e){if(null==e)return e;for(var t=Object.create(null),n=Object.keys(e),a=0;a0){var l=L.utils.clone(t)||{};l.position=[o,s],l.index=r.length,r.push(new L.Token(n.slice(o,i),l))}o=i+1}}return r},L.tokenizer.separator=/[\s\-]+/,L.Pipeline=function(){this._stack=[]},L.Pipeline.registeredFunctions=Object.create(null),L.Pipeline.registerFunction=function(e,t){t in this.registeredFunctions&&L.utils.warn("Overwriting existing registered function: "+t),e.label=t,L.Pipeline.registeredFunctions[e.label]=e},L.Pipeline.warnIfFunctionNotRegistered=function(e){e.label&&e.label in this.registeredFunctions||L.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},L.Pipeline.load=function(e){var t=new L.Pipeline;return e.forEach((function(e){var n=L.Pipeline.registeredFunctions[e];if(!n)throw new Error("Cannot load unregistered function: "+e);t.add(n)})),t},L.Pipeline.prototype.add=function(){Array.prototype.slice.call(arguments).forEach((function(e){L.Pipeline.warnIfFunctionNotRegistered(e),this._stack.push(e)}),this)},L.Pipeline.prototype.after=function(e,t){L.Pipeline.warnIfFunctionNotRegistered(t);var n=this._stack.indexOf(e);if(-1==n)throw new Error("Cannot find existingFn");n+=1,this._stack.splice(n,0,t)},L.Pipeline.prototype.before=function(e,t){L.Pipeline.warnIfFunctionNotRegistered(t);var n=this._stack.indexOf(e);if(-1==n)throw new Error("Cannot find existingFn");this._stack.splice(n,0,t)},L.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);-1!=t&&this._stack.splice(t,1)},L.Pipeline.prototype.run=function(e){for(var t=this._stack.length,n=0;n1&&(ie&&(n=r),i!=e);)a=n-t,r=t+Math.floor(a/2),i=this.elements[2*r];return i==e||i>e?2*r:is?c+=2:o==s&&(t+=n[l+1]*a[c+1],l+=2,c+=2);return t},L.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},L.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,n=0;t0){var i,o=r.str.charAt(0);o in r.node.edges?i=r.node.edges[o]:(i=new L.TokenSet,r.node.edges[o]=i),1==r.str.length&&(i.final=!0),a.push({node:i,editsRemaining:r.editsRemaining,str:r.str.slice(1)})}if(0!=r.editsRemaining){if("*"in r.node.edges)var s=r.node.edges["*"];else{s=new L.TokenSet;r.node.edges["*"]=s}if(0==r.str.length&&(s.final=!0),a.push({node:s,editsRemaining:r.editsRemaining-1,str:r.str}),r.str.length>1&&a.push({node:r.node,editsRemaining:r.editsRemaining-1,str:r.str.slice(1)}),1==r.str.length&&(r.node.final=!0),r.str.length>=1){if("*"in r.node.edges)var l=r.node.edges["*"];else{l=new L.TokenSet;r.node.edges["*"]=l}1==r.str.length&&(l.final=!0),a.push({node:l,editsRemaining:r.editsRemaining-1,str:r.str.slice(1)})}if(r.str.length>1){var c,u=r.str.charAt(0),d=r.str.charAt(1);d in r.node.edges?c=r.node.edges[d]:(c=new L.TokenSet,r.node.edges[d]=c),1==r.str.length&&(c.final=!0),a.push({node:c,editsRemaining:r.editsRemaining-1,str:u+r.str.slice(2)})}}}return n},L.TokenSet.fromString=function(e){for(var t=new L.TokenSet,n=t,a=0,r=e.length;a=e;t--){var n=this.uncheckedNodes[t],a=n.child.toString();a in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[a]:(n.child._str=a,this.minimizedNodes[a]=n.child),this.uncheckedNodes.pop()}},L.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},L.Index.prototype.search=function(e){return this.query((function(t){new L.QueryParser(e,t).parse()}))},L.Index.prototype.query=function(e){for(var t=new L.Query(this.fields),n=Object.create(null),a=Object.create(null),r=Object.create(null),i=Object.create(null),o=Object.create(null),s=0;s1?1:e},L.Builder.prototype.k1=function(e){this._k1=e},L.Builder.prototype.add=function(e,t){var n=e[this._ref],a=Object.keys(this._fields);this._documents[n]=t||{},this.documentCount+=1;for(var r=0;r=this.length)return L.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},L.QueryLexer.prototype.width=function(){return this.pos-this.start},L.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},L.QueryLexer.prototype.backup=function(){this.pos-=1},L.QueryLexer.prototype.acceptDigitRun=function(){var e,t;do{t=(e=this.next()).charCodeAt(0)}while(t>47&&t<58);e!=L.QueryLexer.EOS&&this.backup()},L.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(L.QueryLexer.TERM)),e.ignore(),e.more())return L.QueryLexer.lexText},L.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(L.QueryLexer.EDIT_DISTANCE),L.QueryLexer.lexText},L.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(L.QueryLexer.BOOST),L.QueryLexer.lexText},L.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(L.QueryLexer.TERM)},L.QueryLexer.termSeparator=L.tokenizer.separator,L.QueryLexer.lexText=function(e){for(;;){var t=e.next();if(t==L.QueryLexer.EOS)return L.QueryLexer.lexEOS;if(92!=t.charCodeAt(0)){if(":"==t)return L.QueryLexer.lexField;if("~"==t)return e.backup(),e.width()>0&&e.emit(L.QueryLexer.TERM),L.QueryLexer.lexEditDistance;if("^"==t)return e.backup(),e.width()>0&&e.emit(L.QueryLexer.TERM),L.QueryLexer.lexBoost;if("+"==t&&1===e.width())return e.emit(L.QueryLexer.PRESENCE),L.QueryLexer.lexText;if("-"==t&&1===e.width())return e.emit(L.QueryLexer.PRESENCE),L.QueryLexer.lexText;if(t.match(L.QueryLexer.termSeparator))return L.QueryLexer.lexTerm}else e.escapeCharacter()}},L.QueryParser=function(e,t){this.lexer=new L.QueryLexer(e),this.query=t,this.currentClause={},this.lexemeIdx=0},L.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=L.QueryParser.parseClause;e;)e=e(this);return this.query},L.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},L.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},L.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},L.QueryParser.parseClause=function(e){var t=e.peekLexeme();if(null!=t)switch(t.type){case L.QueryLexer.PRESENCE:return L.QueryParser.parsePresence;case L.QueryLexer.FIELD:return L.QueryParser.parseField;case L.QueryLexer.TERM:return L.QueryParser.parseTerm;default:var n="expected either a field or a term, found "+t.type;throw t.str.length>=1&&(n+=" with value '"+t.str+"'"),new L.QueryParseError(n,t.start,t.end)}},L.QueryParser.parsePresence=function(e){var t=e.consumeLexeme();if(null!=t){switch(t.str){case"-":e.currentClause.presence=L.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=L.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+t.str+"'";throw new L.QueryParseError(n,t.start,t.end)}var a=e.peekLexeme();if(null==a){n="expecting term or field, found nothing";throw new L.QueryParseError(n,t.start,t.end)}switch(a.type){case L.QueryLexer.FIELD:return L.QueryParser.parseField;case L.QueryLexer.TERM:return L.QueryParser.parseTerm;default:n="expecting term or field, found '"+a.type+"'";throw new L.QueryParseError(n,a.start,a.end)}}},L.QueryParser.parseField=function(e){var t=e.consumeLexeme();if(null!=t){if(-1==e.query.allFields.indexOf(t.str)){var n=e.query.allFields.map((function(e){return"'"+e+"'"})).join(", "),a="unrecognised field '"+t.str+"', possible fields: "+n;throw new L.QueryParseError(a,t.start,t.end)}e.currentClause.fields=[t.str];var r=e.peekLexeme();if(null==r){a="expecting term, found nothing";throw new L.QueryParseError(a,t.start,t.end)}if(r.type===L.QueryLexer.TERM)return L.QueryParser.parseTerm;a="expecting term, found '"+r.type+"'";throw new L.QueryParseError(a,r.start,r.end)}},L.QueryParser.parseTerm=function(e){var t=e.consumeLexeme();if(null!=t){e.currentClause.term=t.str.toLowerCase(),-1!=t.str.indexOf("*")&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(null!=n)switch(n.type){case L.QueryLexer.TERM:return e.nextClause(),L.QueryParser.parseTerm;case L.QueryLexer.FIELD:return e.nextClause(),L.QueryParser.parseField;case L.QueryLexer.EDIT_DISTANCE:return L.QueryParser.parseEditDistance;case L.QueryLexer.BOOST:return L.QueryParser.parseBoost;case L.QueryLexer.PRESENCE:return e.nextClause(),L.QueryParser.parsePresence;default:var a="Unexpected lexeme type '"+n.type+"'";throw new L.QueryParseError(a,n.start,n.end)}else e.nextClause()}},L.QueryParser.parseEditDistance=function(e){var t=e.consumeLexeme();if(null!=t){var n=parseInt(t.str,10);if(isNaN(n)){var a="edit distance must be numeric";throw new L.QueryParseError(a,t.start,t.end)}e.currentClause.editDistance=n;var r=e.peekLexeme();if(null!=r)switch(r.type){case L.QueryLexer.TERM:return e.nextClause(),L.QueryParser.parseTerm;case L.QueryLexer.FIELD:return e.nextClause(),L.QueryParser.parseField;case L.QueryLexer.EDIT_DISTANCE:return L.QueryParser.parseEditDistance;case L.QueryLexer.BOOST:return L.QueryParser.parseBoost;case L.QueryLexer.PRESENCE:return e.nextClause(),L.QueryParser.parsePresence;default:a="Unexpected lexeme type '"+r.type+"'";throw new L.QueryParseError(a,r.start,r.end)}else e.nextClause()}},L.QueryParser.parseBoost=function(e){var t=e.consumeLexeme();if(null!=t){var n=parseInt(t.str,10);if(isNaN(n)){var a="boost must be numeric";throw new L.QueryParseError(a,t.start,t.end)}e.currentClause.boost=n;var r=e.peekLexeme();if(null!=r)switch(r.type){case L.QueryLexer.TERM:return e.nextClause(),L.QueryParser.parseTerm;case L.QueryLexer.FIELD:return e.nextClause(),L.QueryParser.parseField;case L.QueryLexer.EDIT_DISTANCE:return L.QueryParser.parseEditDistance;case L.QueryLexer.BOOST:return L.QueryParser.parseBoost;case L.QueryLexer.PRESENCE:return e.nextClause(),L.QueryParser.parsePresence;default:a="Unexpected lexeme type '"+r.type+"'";throw new L.QueryParseError(a,r.start,r.end)}else e.nextClause()}},void 0===(r="function"==typeof(a=function(){return L})?a.call(t,n,t,e):a)||(e.exports=r)}()},48848:(e,t,n)=>{"use strict";n.d(t,{o:()=>i,x:()=>o});var a=n(96540),r=n(74848);const i=a.createContext(!1);function o(e){let{children:t}=e;const[n,o]=(0,a.useState)(!1);return(0,a.useEffect)((()=>{o(!0)}),[]),(0,r.jsx)(i.Provider,{value:n,children:t})}},45022:(e,t,n)=>{"use strict";var a=n(96540),r=n(5338),i=n(54625),o=n(80545),s=n(31712);const l=[n(85300),n(74753),n(75729),n(58252)];var c=n(92413),u=n(56347),d=n(22831),p=n(74848);function m(e){let{children:t}=e;return(0,p.jsx)(p.Fragment,{children:t})}var f=n(21141),h=n(97639),b=n(98180),y=n(86957),g=n(69817),v=n(2098),x=n(19503),w=n(61482),S=n(64609),_=n(51210);function k(){const{i18n:{currentLocale:e,defaultLocale:t,localeConfigs:n}}=(0,h.A)(),a=(0,v.o)(),r=n[e].htmlLang,i=e=>e.replace("-","_");return(0,p.jsxs)(f.A,{children:[Object.entries(n).map((e=>{let[t,{htmlLang:n}]=e;return(0,p.jsx)("link",{rel:"alternate",href:a.createUrl({locale:t,fullyQualified:!0}),hrefLang:n},t)})),(0,p.jsx)("link",{rel:"alternate",href:a.createUrl({locale:t,fullyQualified:!0}),hrefLang:"x-default"}),(0,p.jsx)("meta",{property:"og:locale",content:i(r)}),Object.values(n).filter((e=>r!==e.htmlLang)).map((e=>(0,p.jsx)("meta",{property:"og:locale:alternate",content:i(e.htmlLang)},`meta-og-${e.htmlLang}`)))]})}function j(e){let{permalink:t}=e;const{siteConfig:{url:n}}=(0,h.A)(),a=function(){const{siteConfig:{url:e,baseUrl:t,trailingSlash:n}}=(0,h.A)(),{pathname:a}=(0,u.zy)();return e+(0,S.applyTrailingSlash)((0,b.A)(a),{trailingSlash:n,baseUrl:t})}(),r=t?`${n}${t}`:a;return(0,p.jsxs)(f.A,{children:[(0,p.jsx)("meta",{property:"og:url",content:r}),(0,p.jsx)("link",{rel:"canonical",href:r})]})}function E(){const{i18n:{currentLocale:e}}=(0,h.A)(),{metadata:t,image:n}=(0,y.p)();return(0,p.jsxs)(p.Fragment,{children:[(0,p.jsxs)(f.A,{children:[(0,p.jsx)("meta",{name:"twitter:card",content:"summary_large_image"}),(0,p.jsx)("body",{className:x.w})]}),n&&(0,p.jsx)(g.be,{image:n}),(0,p.jsx)(j,{}),(0,p.jsx)(k,{}),(0,p.jsx)(_.A,{tag:w.Cy,locale:e}),(0,p.jsx)(f.A,{children:t.map(((e,t)=>(0,p.jsx)("meta",{...e},t)))})]})}const O=new Map;function C(e){if(O.has(e.pathname))return{...e,pathname:O.get(e.pathname)};if((0,d.u)(c.A,e.pathname).some((e=>{let{route:t}=e;return!0===t.exact})))return O.set(e.pathname,e.pathname),e;const t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return O.set(e.pathname,t),{...e,pathname:t}}var P=n(48848),A=n(53366),T=n(36494);function I(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),a=1;a{const a=t.default?.[e]??t[e];return a?.(...n)}));return()=>r.forEach((e=>e?.()))}const N=function(e){let{children:t,location:n,previousLocation:a}=e;return(0,T.A)((()=>{a!==n&&(!function(e){let{location:t,previousLocation:n}=e;if(!n)return;const a=t.pathname===n.pathname,r=t.hash===n.hash,i=t.search===n.search;if(a&&r&&!i)return;const{hash:o}=t;if(o){const e=decodeURIComponent(o.substring(1)),t=document.getElementById(e);t?.scrollIntoView()}else window.scrollTo(0,0)}({location:n,previousLocation:a}),I("onRouteDidUpdate",{previousLocation:a,location:n}))}),[a,n]),t};function R(e){const t=Array.from(new Set([e,decodeURI(e)])).map((e=>(0,d.u)(c.A,e))).flat();return Promise.all(t.map((e=>e.route.component.preload?.())))}class L extends a.Component{previousLocation;routeUpdateCleanupCb;constructor(e){super(e),this.previousLocation=null,this.routeUpdateCleanupCb=s.A.canUseDOM?I("onRouteUpdate",{previousLocation:null,location:this.props.location}):()=>{},this.state={nextRouteHasLoaded:!0}}shouldComponentUpdate(e,t){if(e.location===this.props.location)return t.nextRouteHasLoaded;const n=e.location;return this.previousLocation=this.props.location,this.setState({nextRouteHasLoaded:!1}),this.routeUpdateCleanupCb=I("onRouteUpdate",{previousLocation:this.previousLocation,location:n}),R(n.pathname).then((()=>{this.routeUpdateCleanupCb(),this.setState({nextRouteHasLoaded:!0})})).catch((e=>{console.warn(e),window.location.reload()})),!1}render(){const{children:e,location:t}=this.props;return(0,p.jsx)(N,{previousLocation:this.previousLocation,location:t,children:(0,p.jsx)(u.qh,{location:t,render:()=>e})})}}const D=L,q="__docusaurus-base-url-issue-banner-container",F="__docusaurus-base-url-issue-banner",M="__docusaurus-base-url-issue-banner-suggestion-container";function B(e){return`\ndocument.addEventListener('DOMContentLoaded', function maybeInsertBanner() {\n var shouldInsert = typeof window['docusaurus'] === 'undefined';\n shouldInsert && insertBanner();\n});\n\nfunction insertBanner() {\n var bannerContainer = document.createElement('div');\n bannerContainer.id = '${q}';\n var bannerHtml = ${JSON.stringify(function(e){return`\n
\n

Your Docusaurus site did not load properly.

\n

A very common reason is a wrong site baseUrl configuration.

\n

Current configured baseUrl = ${e} ${"/"===e?" (default value)":""}

\n

We suggest trying baseUrl =

\n
\n`}(e)).replace(/{if("undefined"==typeof document)return void n();const a=document.createElement("link");a.setAttribute("rel","prefetch"),a.setAttribute("href",e),a.onload=()=>t(),a.onerror=()=>n();const r=document.getElementsByTagName("head")[0]??document.getElementsByName("script")[0]?.parentNode;r?.appendChild(a)}))}:function(e){return new Promise(((t,n)=>{const a=new XMLHttpRequest;a.open("GET",e,!0),a.withCredentials=!0,a.onload=()=>{200===a.status?t():n()},a.send(null)}))};var Y=n(81604);const J=new Set,Z=new Set,X=()=>navigator.connection?.effectiveType.includes("2g")||navigator.connection?.saveData,ee={prefetch(e){if(!(e=>!X()&&!Z.has(e)&&!J.has(e))(e))return!1;J.add(e);const t=(0,d.u)(c.A,e).flatMap((e=>{return t=e.route.path,Object.entries(W).filter((e=>{let[n]=e;return n.replace(/-[^-]+$/,"")===t})).flatMap((e=>{let[,t]=e;return Object.values((0,Y.A)(t))}));var t}));return Promise.all(t.map((e=>{const t=n.gca(e);return t&&!t.includes("undefined")?K(t).catch((()=>{})):Promise.resolve()})))},preload:e=>!!(e=>!X()&&!Z.has(e))(e)&&(Z.add(e),R(e))},te=Object.freeze(ee),ne=Boolean(!0);if(s.A.canUseDOM){window.docusaurus=te;const e=document.getElementById("__docusaurus"),t=(0,p.jsx)(o.vd,{children:(0,p.jsx)(i.Kd,{children:(0,p.jsx)(V,{})})}),n=(e,t)=>{console.error("Docusaurus React Root onRecoverableError:",e,t)},s=()=>{if(ne)a.startTransition((()=>{r.hydrateRoot(e,t,{onRecoverableError:n})}));else{const i=r.createRoot(e,{onRecoverableError:n});a.startTransition((()=>{i.render(t)}))}};R(window.location.pathname).then(s)}},53366:(e,t,n)=>{"use strict";n.d(t,{o:()=>d,l:()=>p});var a=n(96540),r=n(4784);const i=JSON.parse('{"@cmfcmf/docusaurus-search-local":{"default":{"titleBoost":5,"contentBoost":1,"tagsBoost":3,"parentCategoriesBoost":2,"indexDocSidebarParentCategories":0,"maxSearchResults":8}},"docusaurus-plugin-content-docs":{"example-default":{"path":"/examples/default","versions":[{"name":"current","label":"Next","isLast":true,"path":"/examples/default","mainDocId":"schema","docs":[{"id":"api/directives/include","path":"/examples/default/api/directives/include","sidebar":"schemaSidebar"},{"id":"api/directives/skip","path":"/examples/default/api/directives/skip","sidebar":"schemaSidebar"},{"id":"api/mutations/delete-activity","path":"/examples/default/api/mutations/delete-activity","sidebar":"schemaSidebar"},{"id":"api/mutations/delete-activity-reply","path":"/examples/default/api/mutations/delete-activity-reply","sidebar":"schemaSidebar"},{"id":"api/mutations/delete-custom-list","path":"/examples/default/api/mutations/delete-custom-list","sidebar":"schemaSidebar"},{"id":"api/mutations/delete-media-list-entry","path":"/examples/default/api/mutations/delete-media-list-entry","sidebar":"schemaSidebar"},{"id":"api/mutations/delete-review","path":"/examples/default/api/mutations/delete-review","sidebar":"schemaSidebar"},{"id":"api/mutations/delete-thread","path":"/examples/default/api/mutations/delete-thread","sidebar":"schemaSidebar"},{"id":"api/mutations/delete-thread-comment","path":"/examples/default/api/mutations/delete-thread-comment","sidebar":"schemaSidebar"},{"id":"api/mutations/rate-review","path":"/examples/default/api/mutations/rate-review","sidebar":"schemaSidebar"},{"id":"api/mutations/save-activity-reply","path":"/examples/default/api/mutations/save-activity-reply","sidebar":"schemaSidebar"},{"id":"api/mutations/save-list-activity","path":"/examples/default/api/mutations/save-list-activity","sidebar":"schemaSidebar"},{"id":"api/mutations/save-media-list-entry","path":"/examples/default/api/mutations/save-media-list-entry","sidebar":"schemaSidebar"},{"id":"api/mutations/save-message-activity","path":"/examples/default/api/mutations/save-message-activity","sidebar":"schemaSidebar"},{"id":"api/mutations/save-recommendation","path":"/examples/default/api/mutations/save-recommendation","sidebar":"schemaSidebar"},{"id":"api/mutations/save-review","path":"/examples/default/api/mutations/save-review","sidebar":"schemaSidebar"},{"id":"api/mutations/save-text-activity","path":"/examples/default/api/mutations/save-text-activity","sidebar":"schemaSidebar"},{"id":"api/mutations/save-thread","path":"/examples/default/api/mutations/save-thread","sidebar":"schemaSidebar"},{"id":"api/mutations/save-thread-comment","path":"/examples/default/api/mutations/save-thread-comment","sidebar":"schemaSidebar"},{"id":"api/mutations/toggle-activity-pin","path":"/examples/default/api/mutations/toggle-activity-pin","sidebar":"schemaSidebar"},{"id":"api/mutations/toggle-activity-subscription","path":"/examples/default/api/mutations/toggle-activity-subscription","sidebar":"schemaSidebar"},{"id":"api/mutations/toggle-favourite","path":"/examples/default/api/mutations/toggle-favourite","sidebar":"schemaSidebar"},{"id":"api/mutations/toggle-follow","path":"/examples/default/api/mutations/toggle-follow","sidebar":"schemaSidebar"},{"id":"api/mutations/toggle-like","path":"/examples/default/api/mutations/toggle-like","sidebar":"schemaSidebar"},{"id":"api/mutations/toggle-like-v2","path":"/examples/default/api/mutations/toggle-like-v2","sidebar":"schemaSidebar"},{"id":"api/mutations/toggle-thread-subscription","path":"/examples/default/api/mutations/toggle-thread-subscription","sidebar":"schemaSidebar"},{"id":"api/mutations/update-ani-chart-highlights","path":"/examples/default/api/mutations/update-ani-chart-highlights","sidebar":"schemaSidebar"},{"id":"api/mutations/update-ani-chart-settings","path":"/examples/default/api/mutations/update-ani-chart-settings","sidebar":"schemaSidebar"},{"id":"api/mutations/update-favourite-order","path":"/examples/default/api/mutations/update-favourite-order","sidebar":"schemaSidebar"},{"id":"api/mutations/update-media-list-entries","path":"/examples/default/api/mutations/update-media-list-entries","sidebar":"schemaSidebar"},{"id":"api/mutations/update-user","path":"/examples/default/api/mutations/update-user","sidebar":"schemaSidebar"},{"id":"api/queries/activity","path":"/examples/default/api/queries/activity","sidebar":"schemaSidebar"},{"id":"api/queries/activity-reply","path":"/examples/default/api/queries/activity-reply","sidebar":"schemaSidebar"},{"id":"api/queries/airing-schedule","path":"/examples/default/api/queries/airing-schedule","sidebar":"schemaSidebar"},{"id":"api/queries/ani-chart-user","path":"/examples/default/api/queries/ani-chart-user","sidebar":"schemaSidebar"},{"id":"api/queries/character","path":"/examples/default/api/queries/character","sidebar":"schemaSidebar"},{"id":"api/queries/external-link-source-collection","path":"/examples/default/api/queries/external-link-source-collection","sidebar":"schemaSidebar"},{"id":"api/queries/follower","path":"/examples/default/api/queries/follower","sidebar":"schemaSidebar"},{"id":"api/queries/following","path":"/examples/default/api/queries/following","sidebar":"schemaSidebar"},{"id":"api/queries/genre-collection","path":"/examples/default/api/queries/genre-collection","sidebar":"schemaSidebar"},{"id":"api/queries/like","path":"/examples/default/api/queries/like","sidebar":"schemaSidebar"},{"id":"api/queries/markdown","path":"/examples/default/api/queries/markdown","sidebar":"schemaSidebar"},{"id":"api/queries/media","path":"/examples/default/api/queries/media","sidebar":"schemaSidebar"},{"id":"api/queries/media-list","path":"/examples/default/api/queries/media-list","sidebar":"schemaSidebar"},{"id":"api/queries/media-list-collection","path":"/examples/default/api/queries/media-list-collection","sidebar":"schemaSidebar"},{"id":"api/queries/media-tag-collection","path":"/examples/default/api/queries/media-tag-collection","sidebar":"schemaSidebar"},{"id":"api/queries/media-trend","path":"/examples/default/api/queries/media-trend","sidebar":"schemaSidebar"},{"id":"api/queries/notification","path":"/examples/default/api/queries/notification","sidebar":"schemaSidebar"},{"id":"api/queries/page","path":"/examples/default/api/queries/page","sidebar":"schemaSidebar"},{"id":"api/queries/recommendation","path":"/examples/default/api/queries/recommendation","sidebar":"schemaSidebar"},{"id":"api/queries/review","path":"/examples/default/api/queries/review","sidebar":"schemaSidebar"},{"id":"api/queries/site-statistics","path":"/examples/default/api/queries/site-statistics","sidebar":"schemaSidebar"},{"id":"api/queries/staff","path":"/examples/default/api/queries/staff","sidebar":"schemaSidebar"},{"id":"api/queries/studio","path":"/examples/default/api/queries/studio","sidebar":"schemaSidebar"},{"id":"api/queries/thread","path":"/examples/default/api/queries/thread","sidebar":"schemaSidebar"},{"id":"api/queries/thread-comment","path":"/examples/default/api/queries/thread-comment","sidebar":"schemaSidebar"},{"id":"api/queries/user","path":"/examples/default/api/queries/user","sidebar":"schemaSidebar"},{"id":"api/queries/viewer","path":"/examples/default/api/queries/viewer","sidebar":"schemaSidebar"},{"id":"schema","path":"/examples/default/","sidebar":"schemaSidebar"},{"id":"types/directives/deprecated","path":"/examples/default/types/directives/deprecated","sidebar":"schemaSidebar"},{"id":"types/enums/activity-sort","path":"/examples/default/types/enums/activity-sort","sidebar":"schemaSidebar"},{"id":"types/enums/activity-type","path":"/examples/default/types/enums/activity-type","sidebar":"schemaSidebar"},{"id":"types/enums/airing-sort","path":"/examples/default/types/enums/airing-sort","sidebar":"schemaSidebar"},{"id":"types/enums/character-role","path":"/examples/default/types/enums/character-role","sidebar":"schemaSidebar"},{"id":"types/enums/character-sort","path":"/examples/default/types/enums/character-sort","sidebar":"schemaSidebar"},{"id":"types/enums/external-link-media-type","path":"/examples/default/types/enums/external-link-media-type","sidebar":"schemaSidebar"},{"id":"types/enums/external-link-type","path":"/examples/default/types/enums/external-link-type","sidebar":"schemaSidebar"},{"id":"types/enums/likeable-type","path":"/examples/default/types/enums/likeable-type","sidebar":"schemaSidebar"},{"id":"types/enums/media-format","path":"/examples/default/types/enums/media-format","sidebar":"schemaSidebar"},{"id":"types/enums/media-list-sort","path":"/examples/default/types/enums/media-list-sort","sidebar":"schemaSidebar"},{"id":"types/enums/media-list-status","path":"/examples/default/types/enums/media-list-status","sidebar":"schemaSidebar"},{"id":"types/enums/media-rank-type","path":"/examples/default/types/enums/media-rank-type","sidebar":"schemaSidebar"},{"id":"types/enums/media-relation","path":"/examples/default/types/enums/media-relation","sidebar":"schemaSidebar"},{"id":"types/enums/media-season","path":"/examples/default/types/enums/media-season","sidebar":"schemaSidebar"},{"id":"types/enums/media-sort","path":"/examples/default/types/enums/media-sort","sidebar":"schemaSidebar"},{"id":"types/enums/media-source","path":"/examples/default/types/enums/media-source","sidebar":"schemaSidebar"},{"id":"types/enums/media-status","path":"/examples/default/types/enums/media-status","sidebar":"schemaSidebar"},{"id":"types/enums/media-trend-sort","path":"/examples/default/types/enums/media-trend-sort","sidebar":"schemaSidebar"},{"id":"types/enums/media-type","path":"/examples/default/types/enums/media-type","sidebar":"schemaSidebar"},{"id":"types/enums/mod-action-type","path":"/examples/default/types/enums/mod-action-type","sidebar":"schemaSidebar"},{"id":"types/enums/mod-role","path":"/examples/default/types/enums/mod-role","sidebar":"schemaSidebar"},{"id":"types/enums/notification-type","path":"/examples/default/types/enums/notification-type","sidebar":"schemaSidebar"},{"id":"types/enums/recommendation-rating","path":"/examples/default/types/enums/recommendation-rating","sidebar":"schemaSidebar"},{"id":"types/enums/recommendation-sort","path":"/examples/default/types/enums/recommendation-sort","sidebar":"schemaSidebar"},{"id":"types/enums/review-rating","path":"/examples/default/types/enums/review-rating","sidebar":"schemaSidebar"},{"id":"types/enums/review-sort","path":"/examples/default/types/enums/review-sort","sidebar":"schemaSidebar"},{"id":"types/enums/revision-history-action","path":"/examples/default/types/enums/revision-history-action","sidebar":"schemaSidebar"},{"id":"types/enums/score-format","path":"/examples/default/types/enums/score-format","sidebar":"schemaSidebar"},{"id":"types/enums/site-trend-sort","path":"/examples/default/types/enums/site-trend-sort","sidebar":"schemaSidebar"},{"id":"types/enums/staff-language","path":"/examples/default/types/enums/staff-language","sidebar":"schemaSidebar"},{"id":"types/enums/staff-sort","path":"/examples/default/types/enums/staff-sort","sidebar":"schemaSidebar"},{"id":"types/enums/studio-sort","path":"/examples/default/types/enums/studio-sort","sidebar":"schemaSidebar"},{"id":"types/enums/submission-sort","path":"/examples/default/types/enums/submission-sort","sidebar":"schemaSidebar"},{"id":"types/enums/submission-status","path":"/examples/default/types/enums/submission-status","sidebar":"schemaSidebar"},{"id":"types/enums/thread-comment-sort","path":"/examples/default/types/enums/thread-comment-sort","sidebar":"schemaSidebar"},{"id":"types/enums/thread-sort","path":"/examples/default/types/enums/thread-sort","sidebar":"schemaSidebar"},{"id":"types/enums/user-sort","path":"/examples/default/types/enums/user-sort","sidebar":"schemaSidebar"},{"id":"types/enums/user-staff-name-language","path":"/examples/default/types/enums/user-staff-name-language","sidebar":"schemaSidebar"},{"id":"types/enums/user-statistics-sort","path":"/examples/default/types/enums/user-statistics-sort","sidebar":"schemaSidebar"},{"id":"types/enums/user-title-language","path":"/examples/default/types/enums/user-title-language","sidebar":"schemaSidebar"},{"id":"types/inputs/airing-schedule-input","path":"/examples/default/types/inputs/airing-schedule-input","sidebar":"schemaSidebar"},{"id":"types/inputs/ani-chart-highlight-input","path":"/examples/default/types/inputs/ani-chart-highlight-input","sidebar":"schemaSidebar"},{"id":"types/inputs/character-name-input","path":"/examples/default/types/inputs/character-name-input","sidebar":"schemaSidebar"},{"id":"types/inputs/fuzzy-date-input","path":"/examples/default/types/inputs/fuzzy-date-input","sidebar":"schemaSidebar"},{"id":"types/inputs/list-activity-option-input","path":"/examples/default/types/inputs/list-activity-option-input","sidebar":"schemaSidebar"},{"id":"types/inputs/media-external-link-input","path":"/examples/default/types/inputs/media-external-link-input","sidebar":"schemaSidebar"},{"id":"types/inputs/media-list-options-input","path":"/examples/default/types/inputs/media-list-options-input","sidebar":"schemaSidebar"},{"id":"types/inputs/media-title-input","path":"/examples/default/types/inputs/media-title-input","sidebar":"schemaSidebar"},{"id":"types/inputs/notification-option-input","path":"/examples/default/types/inputs/notification-option-input","sidebar":"schemaSidebar"},{"id":"types/inputs/staff-name-input","path":"/examples/default/types/inputs/staff-name-input","sidebar":"schemaSidebar"},{"id":"types/objects/activity-like-notification","path":"/examples/default/types/objects/activity-like-notification","sidebar":"schemaSidebar"},{"id":"types/objects/activity-mention-notification","path":"/examples/default/types/objects/activity-mention-notification","sidebar":"schemaSidebar"},{"id":"types/objects/activity-message-notification","path":"/examples/default/types/objects/activity-message-notification","sidebar":"schemaSidebar"},{"id":"types/objects/activity-reply","path":"/examples/default/types/objects/activity-reply","sidebar":"schemaSidebar"},{"id":"types/objects/activity-reply-like-notification","path":"/examples/default/types/objects/activity-reply-like-notification","sidebar":"schemaSidebar"},{"id":"types/objects/activity-reply-notification","path":"/examples/default/types/objects/activity-reply-notification","sidebar":"schemaSidebar"},{"id":"types/objects/activity-reply-subscribed-notification","path":"/examples/default/types/objects/activity-reply-subscribed-notification","sidebar":"schemaSidebar"},{"id":"types/objects/airing-notification","path":"/examples/default/types/objects/airing-notification","sidebar":"schemaSidebar"},{"id":"types/objects/airing-progression","path":"/examples/default/types/objects/airing-progression","sidebar":"schemaSidebar"},{"id":"types/objects/airing-schedule","path":"/examples/default/types/objects/airing-schedule","sidebar":"schemaSidebar"},{"id":"types/objects/airing-schedule-connection","path":"/examples/default/types/objects/airing-schedule-connection","sidebar":"schemaSidebar"},{"id":"types/objects/airing-schedule-edge","path":"/examples/default/types/objects/airing-schedule-edge","sidebar":"schemaSidebar"},{"id":"types/objects/ani-chart-user","path":"/examples/default/types/objects/ani-chart-user","sidebar":"schemaSidebar"},{"id":"types/objects/character","path":"/examples/default/types/objects/character","sidebar":"schemaSidebar"},{"id":"types/objects/character-connection","path":"/examples/default/types/objects/character-connection","sidebar":"schemaSidebar"},{"id":"types/objects/character-edge","path":"/examples/default/types/objects/character-edge","sidebar":"schemaSidebar"},{"id":"types/objects/character-image","path":"/examples/default/types/objects/character-image","sidebar":"schemaSidebar"},{"id":"types/objects/character-name","path":"/examples/default/types/objects/character-name","sidebar":"schemaSidebar"},{"id":"types/objects/character-submission","path":"/examples/default/types/objects/character-submission","sidebar":"schemaSidebar"},{"id":"types/objects/character-submission-connection","path":"/examples/default/types/objects/character-submission-connection","sidebar":"schemaSidebar"},{"id":"types/objects/character-submission-edge","path":"/examples/default/types/objects/character-submission-edge","sidebar":"schemaSidebar"},{"id":"types/objects/deleted","path":"/examples/default/types/objects/deleted","sidebar":"schemaSidebar"},{"id":"types/objects/favourites","path":"/examples/default/types/objects/favourites","sidebar":"schemaSidebar"},{"id":"types/objects/following-notification","path":"/examples/default/types/objects/following-notification","sidebar":"schemaSidebar"},{"id":"types/objects/format-stats","path":"/examples/default/types/objects/format-stats","sidebar":"schemaSidebar"},{"id":"types/objects/fuzzy-date","path":"/examples/default/types/objects/fuzzy-date","sidebar":"schemaSidebar"},{"id":"types/objects/genre-stats","path":"/examples/default/types/objects/genre-stats","sidebar":"schemaSidebar"},{"id":"types/objects/internal-page","path":"/examples/default/types/objects/internal-page","sidebar":"schemaSidebar"},{"id":"types/objects/list-activity","path":"/examples/default/types/objects/list-activity","sidebar":"schemaSidebar"},{"id":"types/objects/list-activity-option","path":"/examples/default/types/objects/list-activity-option","sidebar":"schemaSidebar"},{"id":"types/objects/list-score-stats","path":"/examples/default/types/objects/list-score-stats","sidebar":"schemaSidebar"},{"id":"types/objects/media","path":"/examples/default/types/objects/media","sidebar":"schemaSidebar"},{"id":"types/objects/media-character","path":"/examples/default/types/objects/media-character","sidebar":"schemaSidebar"},{"id":"types/objects/media-connection","path":"/examples/default/types/objects/media-connection","sidebar":"schemaSidebar"},{"id":"types/objects/media-cover-image","path":"/examples/default/types/objects/media-cover-image","sidebar":"schemaSidebar"},{"id":"types/objects/media-data-change-notification","path":"/examples/default/types/objects/media-data-change-notification","sidebar":"schemaSidebar"},{"id":"types/objects/media-deletion-notification","path":"/examples/default/types/objects/media-deletion-notification","sidebar":"schemaSidebar"},{"id":"types/objects/media-edge","path":"/examples/default/types/objects/media-edge","sidebar":"schemaSidebar"},{"id":"types/objects/media-external-link","path":"/examples/default/types/objects/media-external-link","sidebar":"schemaSidebar"},{"id":"types/objects/media-list","path":"/examples/default/types/objects/media-list","sidebar":"schemaSidebar"},{"id":"types/objects/media-list-collection","path":"/examples/default/types/objects/media-list-collection","sidebar":"schemaSidebar"},{"id":"types/objects/media-list-group","path":"/examples/default/types/objects/media-list-group","sidebar":"schemaSidebar"},{"id":"types/objects/media-list-options","path":"/examples/default/types/objects/media-list-options","sidebar":"schemaSidebar"},{"id":"types/objects/media-list-type-options","path":"/examples/default/types/objects/media-list-type-options","sidebar":"schemaSidebar"},{"id":"types/objects/media-merge-notification","path":"/examples/default/types/objects/media-merge-notification","sidebar":"schemaSidebar"},{"id":"types/objects/media-rank","path":"/examples/default/types/objects/media-rank","sidebar":"schemaSidebar"},{"id":"types/objects/media-stats","path":"/examples/default/types/objects/media-stats","sidebar":"schemaSidebar"},{"id":"types/objects/media-streaming-episode","path":"/examples/default/types/objects/media-streaming-episode","sidebar":"schemaSidebar"},{"id":"types/objects/media-submission","path":"/examples/default/types/objects/media-submission","sidebar":"schemaSidebar"},{"id":"types/objects/media-submission-comparison","path":"/examples/default/types/objects/media-submission-comparison","sidebar":"schemaSidebar"},{"id":"types/objects/media-submission-edge","path":"/examples/default/types/objects/media-submission-edge","sidebar":"schemaSidebar"},{"id":"types/objects/media-tag","path":"/examples/default/types/objects/media-tag","sidebar":"schemaSidebar"},{"id":"types/objects/media-title","path":"/examples/default/types/objects/media-title","sidebar":"schemaSidebar"},{"id":"types/objects/media-trailer","path":"/examples/default/types/objects/media-trailer","sidebar":"schemaSidebar"},{"id":"types/objects/media-trend","path":"/examples/default/types/objects/media-trend","sidebar":"schemaSidebar"},{"id":"types/objects/media-trend-connection","path":"/examples/default/types/objects/media-trend-connection","sidebar":"schemaSidebar"},{"id":"types/objects/media-trend-edge","path":"/examples/default/types/objects/media-trend-edge","sidebar":"schemaSidebar"},{"id":"types/objects/message-activity","path":"/examples/default/types/objects/message-activity","sidebar":"schemaSidebar"},{"id":"types/objects/mod-action","path":"/examples/default/types/objects/mod-action","sidebar":"schemaSidebar"},{"id":"types/objects/notification-option","path":"/examples/default/types/objects/notification-option","sidebar":"schemaSidebar"},{"id":"types/objects/page","path":"/examples/default/types/objects/page","sidebar":"schemaSidebar"},{"id":"types/objects/page-info","path":"/examples/default/types/objects/page-info","sidebar":"schemaSidebar"},{"id":"types/objects/parsed-markdown","path":"/examples/default/types/objects/parsed-markdown","sidebar":"schemaSidebar"},{"id":"types/objects/recommendation","path":"/examples/default/types/objects/recommendation","sidebar":"schemaSidebar"},{"id":"types/objects/recommendation-connection","path":"/examples/default/types/objects/recommendation-connection","sidebar":"schemaSidebar"},{"id":"types/objects/recommendation-edge","path":"/examples/default/types/objects/recommendation-edge","sidebar":"schemaSidebar"},{"id":"types/objects/related-media-addition-notification","path":"/examples/default/types/objects/related-media-addition-notification","sidebar":"schemaSidebar"},{"id":"types/objects/report","path":"/examples/default/types/objects/report","sidebar":"schemaSidebar"},{"id":"types/objects/review","path":"/examples/default/types/objects/review","sidebar":"schemaSidebar"},{"id":"types/objects/review-connection","path":"/examples/default/types/objects/review-connection","sidebar":"schemaSidebar"},{"id":"types/objects/review-edge","path":"/examples/default/types/objects/review-edge","sidebar":"schemaSidebar"},{"id":"types/objects/revision-history","path":"/examples/default/types/objects/revision-history","sidebar":"schemaSidebar"},{"id":"types/objects/score-distribution","path":"/examples/default/types/objects/score-distribution","sidebar":"schemaSidebar"},{"id":"types/objects/site-statistics","path":"/examples/default/types/objects/site-statistics","sidebar":"schemaSidebar"},{"id":"types/objects/site-trend","path":"/examples/default/types/objects/site-trend","sidebar":"schemaSidebar"},{"id":"types/objects/site-trend-connection","path":"/examples/default/types/objects/site-trend-connection","sidebar":"schemaSidebar"},{"id":"types/objects/site-trend-edge","path":"/examples/default/types/objects/site-trend-edge","sidebar":"schemaSidebar"},{"id":"types/objects/staff","path":"/examples/default/types/objects/staff","sidebar":"schemaSidebar"},{"id":"types/objects/staff-connection","path":"/examples/default/types/objects/staff-connection","sidebar":"schemaSidebar"},{"id":"types/objects/staff-edge","path":"/examples/default/types/objects/staff-edge","sidebar":"schemaSidebar"},{"id":"types/objects/staff-image","path":"/examples/default/types/objects/staff-image","sidebar":"schemaSidebar"},{"id":"types/objects/staff-name","path":"/examples/default/types/objects/staff-name","sidebar":"schemaSidebar"},{"id":"types/objects/staff-role-type","path":"/examples/default/types/objects/staff-role-type","sidebar":"schemaSidebar"},{"id":"types/objects/staff-stats","path":"/examples/default/types/objects/staff-stats","sidebar":"schemaSidebar"},{"id":"types/objects/staff-submission","path":"/examples/default/types/objects/staff-submission","sidebar":"schemaSidebar"},{"id":"types/objects/status-distribution","path":"/examples/default/types/objects/status-distribution","sidebar":"schemaSidebar"},{"id":"types/objects/studio","path":"/examples/default/types/objects/studio","sidebar":"schemaSidebar"},{"id":"types/objects/studio-connection","path":"/examples/default/types/objects/studio-connection","sidebar":"schemaSidebar"},{"id":"types/objects/studio-edge","path":"/examples/default/types/objects/studio-edge","sidebar":"schemaSidebar"},{"id":"types/objects/studio-stats","path":"/examples/default/types/objects/studio-stats","sidebar":"schemaSidebar"},{"id":"types/objects/tag-stats","path":"/examples/default/types/objects/tag-stats","sidebar":"schemaSidebar"},{"id":"types/objects/text-activity","path":"/examples/default/types/objects/text-activity","sidebar":"schemaSidebar"},{"id":"types/objects/thread","path":"/examples/default/types/objects/thread","sidebar":"schemaSidebar"},{"id":"types/objects/thread-category","path":"/examples/default/types/objects/thread-category","sidebar":"schemaSidebar"},{"id":"types/objects/thread-comment","path":"/examples/default/types/objects/thread-comment","sidebar":"schemaSidebar"},{"id":"types/objects/thread-comment-like-notification","path":"/examples/default/types/objects/thread-comment-like-notification","sidebar":"schemaSidebar"},{"id":"types/objects/thread-comment-mention-notification","path":"/examples/default/types/objects/thread-comment-mention-notification","sidebar":"schemaSidebar"},{"id":"types/objects/thread-comment-reply-notification","path":"/examples/default/types/objects/thread-comment-reply-notification","sidebar":"schemaSidebar"},{"id":"types/objects/thread-comment-subscribed-notification","path":"/examples/default/types/objects/thread-comment-subscribed-notification","sidebar":"schemaSidebar"},{"id":"types/objects/thread-like-notification","path":"/examples/default/types/objects/thread-like-notification","sidebar":"schemaSidebar"},{"id":"types/objects/user","path":"/examples/default/types/objects/user","sidebar":"schemaSidebar"},{"id":"types/objects/user-activity-history","path":"/examples/default/types/objects/user-activity-history","sidebar":"schemaSidebar"},{"id":"types/objects/user-avatar","path":"/examples/default/types/objects/user-avatar","sidebar":"schemaSidebar"},{"id":"types/objects/user-country-statistic","path":"/examples/default/types/objects/user-country-statistic","sidebar":"schemaSidebar"},{"id":"types/objects/user-format-statistic","path":"/examples/default/types/objects/user-format-statistic","sidebar":"schemaSidebar"},{"id":"types/objects/user-genre-statistic","path":"/examples/default/types/objects/user-genre-statistic","sidebar":"schemaSidebar"},{"id":"types/objects/user-length-statistic","path":"/examples/default/types/objects/user-length-statistic","sidebar":"schemaSidebar"},{"id":"types/objects/user-mod-data","path":"/examples/default/types/objects/user-mod-data","sidebar":"schemaSidebar"},{"id":"types/objects/user-options","path":"/examples/default/types/objects/user-options","sidebar":"schemaSidebar"},{"id":"types/objects/user-previous-name","path":"/examples/default/types/objects/user-previous-name","sidebar":"schemaSidebar"},{"id":"types/objects/user-release-year-statistic","path":"/examples/default/types/objects/user-release-year-statistic","sidebar":"schemaSidebar"},{"id":"types/objects/user-score-statistic","path":"/examples/default/types/objects/user-score-statistic","sidebar":"schemaSidebar"},{"id":"types/objects/user-staff-statistic","path":"/examples/default/types/objects/user-staff-statistic","sidebar":"schemaSidebar"},{"id":"types/objects/user-start-year-statistic","path":"/examples/default/types/objects/user-start-year-statistic","sidebar":"schemaSidebar"},{"id":"types/objects/user-statistic-types","path":"/examples/default/types/objects/user-statistic-types","sidebar":"schemaSidebar"},{"id":"types/objects/user-statistics","path":"/examples/default/types/objects/user-statistics","sidebar":"schemaSidebar"},{"id":"types/objects/user-stats","path":"/examples/default/types/objects/user-stats","sidebar":"schemaSidebar"},{"id":"types/objects/user-status-statistic","path":"/examples/default/types/objects/user-status-statistic","sidebar":"schemaSidebar"},{"id":"types/objects/user-studio-statistic","path":"/examples/default/types/objects/user-studio-statistic","sidebar":"schemaSidebar"},{"id":"types/objects/user-tag-statistic","path":"/examples/default/types/objects/user-tag-statistic","sidebar":"schemaSidebar"},{"id":"types/objects/user-voice-actor-statistic","path":"/examples/default/types/objects/user-voice-actor-statistic","sidebar":"schemaSidebar"},{"id":"types/objects/year-stats","path":"/examples/default/types/objects/year-stats","sidebar":"schemaSidebar"},{"id":"types/scalars/boolean","path":"/examples/default/types/scalars/boolean","sidebar":"schemaSidebar"},{"id":"types/scalars/country-code","path":"/examples/default/types/scalars/country-code","sidebar":"schemaSidebar"},{"id":"types/scalars/float","path":"/examples/default/types/scalars/float","sidebar":"schemaSidebar"},{"id":"types/scalars/fuzzy-date-int","path":"/examples/default/types/scalars/fuzzy-date-int","sidebar":"schemaSidebar"},{"id":"types/scalars/id","path":"/examples/default/types/scalars/id","sidebar":"schemaSidebar"},{"id":"types/scalars/int","path":"/examples/default/types/scalars/int","sidebar":"schemaSidebar"},{"id":"types/scalars/json","path":"/examples/default/types/scalars/json","sidebar":"schemaSidebar"},{"id":"types/scalars/string","path":"/examples/default/types/scalars/string","sidebar":"schemaSidebar"},{"id":"types/unions/activity-union","path":"/examples/default/types/unions/activity-union","sidebar":"schemaSidebar"},{"id":"types/unions/likeable-union","path":"/examples/default/types/unions/likeable-union","sidebar":"schemaSidebar"},{"id":"types/unions/notification-union","path":"/examples/default/types/unions/notification-union","sidebar":"schemaSidebar"}],"draftIds":[],"sidebars":{"schemaSidebar":{"link":{"path":"/examples/default/","label":"schema"}}}}],"breadcrumbs":true},"example-group-by":{"path":"/examples/group-by","versions":[{"name":"current","label":"Next","isLast":true,"path":"/examples/group-by","mainDocId":"schema","docs":[{"id":"common/directives/auth","path":"/examples/group-by/common/directives/auth","sidebar":"schemaSidebar"},{"id":"common/directives/beta","path":"/examples/group-by/common/directives/beta","sidebar":"schemaSidebar"},{"id":"common/directives/complexity","path":"/examples/group-by/common/directives/complexity","sidebar":"schemaSidebar"},{"id":"common/directives/deprecated","path":"/examples/group-by/common/directives/deprecated","sidebar":"schemaSidebar"},{"id":"common/directives/doc","path":"/examples/group-by/common/directives/doc","sidebar":"schemaSidebar"},{"id":"common/directives/example","path":"/examples/group-by/common/directives/example","sidebar":"schemaSidebar"},{"id":"common/directives/include","path":"/examples/group-by/common/directives/include","sidebar":"schemaSidebar"},{"id":"common/directives/no-doc","path":"/examples/group-by/common/directives/no-doc","sidebar":"schemaSidebar"},{"id":"common/directives/one-of","path":"/examples/group-by/common/directives/one-of","sidebar":"schemaSidebar"},{"id":"common/directives/skip","path":"/examples/group-by/common/directives/skip","sidebar":"schemaSidebar"},{"id":"common/directives/specified-by","path":"/examples/group-by/common/directives/specified-by","sidebar":"schemaSidebar"},{"id":"common/enums/roles","path":"/examples/group-by/common/enums/roles","sidebar":"schemaSidebar"},{"id":"common/interfaces/record","path":"/examples/group-by/common/interfaces/record","sidebar":"schemaSidebar"},{"id":"common/objects/course","path":"/examples/group-by/common/objects/course","sidebar":"schemaSidebar"},{"id":"common/objects/department-information","path":"/examples/group-by/common/objects/department-information","sidebar":"schemaSidebar"},{"id":"common/objects/semester","path":"/examples/group-by/common/objects/semester","sidebar":"schemaSidebar"},{"id":"common/queries/search-role","path":"/examples/group-by/common/queries/search-role","sidebar":"schemaSidebar"},{"id":"common/scalars/boolean","path":"/examples/group-by/common/scalars/boolean","sidebar":"schemaSidebar"},{"id":"common/scalars/date","path":"/examples/group-by/common/scalars/date","sidebar":"schemaSidebar"},{"id":"common/scalars/email-address","path":"/examples/group-by/common/scalars/email-address","sidebar":"schemaSidebar"},{"id":"common/scalars/id","path":"/examples/group-by/common/scalars/id","sidebar":"schemaSidebar"},{"id":"common/scalars/int","path":"/examples/group-by/common/scalars/int","sidebar":"schemaSidebar"},{"id":"common/scalars/phone-number","path":"/examples/group-by/common/scalars/phone-number","sidebar":"schemaSidebar"},{"id":"common/scalars/string","path":"/examples/group-by/common/scalars/string","sidebar":"schemaSidebar"},{"id":"common/scalars/time","path":"/examples/group-by/common/scalars/time","sidebar":"schemaSidebar"},{"id":"common/scalars/url","path":"/examples/group-by/common/scalars/url","sidebar":"schemaSidebar"},{"id":"course/mutations/add-course","path":"/examples/group-by/course/mutations/add-course","sidebar":"schemaSidebar"},{"id":"course/mutations/drop-course","path":"/examples/group-by/course/mutations/drop-course","sidebar":"schemaSidebar"},{"id":"course/queries/all-courses","path":"/examples/group-by/course/queries/all-courses","sidebar":"schemaSidebar"},{"id":"course/queries/course","path":"/examples/group-by/course/queries/course","sidebar":"schemaSidebar"},{"id":"deprecated/course/queries/math-courses","path":"/examples/group-by/deprecated/course/queries/math-courses","sidebar":"schemaSidebar"},{"id":"deprecated/course/queries/science-courses","path":"/examples/group-by/deprecated/course/queries/science-courses","sidebar":"schemaSidebar"},{"id":"grade/mutations/update-gpa","path":"/examples/group-by/grade/mutations/update-gpa","sidebar":"schemaSidebar"},{"id":"grade/mutations/update-grade","path":"/examples/group-by/grade/mutations/update-grade","sidebar":"schemaSidebar"},{"id":"grade/queries/gpa","path":"/examples/group-by/grade/queries/gpa","sidebar":"schemaSidebar"},{"id":"grade/queries/un-weighted-gpa","path":"/examples/group-by/grade/queries/un-weighted-gpa","sidebar":"schemaSidebar"},{"id":"grade/queries/weighted-gpa","path":"/examples/group-by/grade/queries/weighted-gpa","sidebar":"schemaSidebar"},{"id":"schema","path":"/examples/group-by/","sidebar":"schemaSidebar"},{"id":"/category/common","path":"/examples/group-by/category/common","sidebar":"schemaSidebar"},{"id":"/category/directives","path":"/examples/group-by/category/directives","sidebar":"schemaSidebar"},{"id":"/category/enums","path":"/examples/group-by/category/enums","sidebar":"schemaSidebar"},{"id":"/category/interfaces","path":"/examples/group-by/category/interfaces","sidebar":"schemaSidebar"},{"id":"/category/objects","path":"/examples/group-by/category/objects","sidebar":"schemaSidebar"},{"id":"/category/queries","path":"/examples/group-by/category/queries","sidebar":"schemaSidebar"},{"id":"/category/scalars","path":"/examples/group-by/category/scalars","sidebar":"schemaSidebar"},{"id":"/category/course","path":"/examples/group-by/category/course","sidebar":"schemaSidebar"},{"id":"/category/mutations","path":"/examples/group-by/category/mutations","sidebar":"schemaSidebar"},{"id":"/category/queries-1","path":"/examples/group-by/category/queries-1","sidebar":"schemaSidebar"},{"id":"/category/grade","path":"/examples/group-by/category/grade","sidebar":"schemaSidebar"},{"id":"/category/mutations-1","path":"/examples/group-by/category/mutations-1","sidebar":"schemaSidebar"},{"id":"/category/queries-2","path":"/examples/group-by/category/queries-2","sidebar":"schemaSidebar"},{"id":"/category/deprecated","path":"/examples/group-by/category/deprecated","sidebar":"schemaSidebar"},{"id":"/category/course-1","path":"/examples/group-by/category/course-1","sidebar":"schemaSidebar"},{"id":"/category/queries-3","path":"/examples/group-by/category/queries-3","sidebar":"schemaSidebar"}],"draftIds":[],"sidebars":{"schemaSidebar":{"link":{"path":"/examples/group-by/category/common","label":"Common"}}}}],"breadcrumbs":true},"default":{"path":"/docs","versions":[{"name":"current","label":"Next","isLast":true,"path":"/docs","mainDocId":"intro","docs":[{"id":"advanced/additional-schema","path":"/docs/advanced/additional-schema","sidebar":"defaultSidebar"},{"id":"advanced/custom-deprecated-section","path":"/docs/advanced/custom-deprecated-section","sidebar":"defaultSidebar"},{"id":"advanced/custom-directive","path":"/docs/advanced/custom-directive","sidebar":"defaultSidebar"},{"id":"advanced/custom-root-types","path":"/docs/advanced/custom-root-types","sidebar":"defaultSidebar"},{"id":"advanced/docs-multi-instance","path":"/docs/advanced/docs-multi-instance","sidebar":"defaultSidebar"},{"id":"advanced/examples","path":"/docs/advanced/examples","sidebar":"defaultSidebar"},{"id":"advanced/group-by-directive","path":"/docs/advanced/group-by-directive","sidebar":"defaultSidebar"},{"id":"advanced/homepage","path":"/docs/advanced/homepage","sidebar":"defaultSidebar"},{"id":"advanced/schema-loading","path":"/docs/advanced/schema-loading","sidebar":"defaultSidebar"},{"id":"configuration","path":"/docs/configuration","sidebar":"defaultSidebar"},{"id":"get-started","path":"/docs/get-started","sidebar":"defaultSidebar"},{"id":"intro","path":"/docs/intro","sidebar":"defaultSidebar"},{"id":"settings","path":"/docs/settings","sidebar":"defaultSidebar"},{"id":"troubleshooting","path":"/docs/troubleshooting","sidebar":"defaultSidebar"},{"id":"try-it","path":"/docs/try-it","sidebar":"defaultSidebar"},{"id":"/category/advanced-settings","path":"/docs/category/advanced-settings","sidebar":"defaultSidebar"}],"draftIds":[],"sidebars":{"defaultSidebar":{"link":{"path":"/docs/intro","label":"intro"}}}}],"breadcrumbs":true},"api":{"path":"/api","versions":[{"name":"current","label":"Next","isLast":true,"path":"/api","mainDocId":"index","docs":[{"id":"core/config","path":"/api/core/config","sidebar":"defaultSidebar"},{"id":"core/diff","path":"/api/core/diff","sidebar":"defaultSidebar"},{"id":"core/generator","path":"/api/core/generator","sidebar":"defaultSidebar"},{"id":"core/graphql-config","path":"/api/core/graphql-config","sidebar":"defaultSidebar"},{"id":"core/printer","path":"/api/core/printer","sidebar":"defaultSidebar"},{"id":"core/renderer","path":"/api/core/renderer","sidebar":"defaultSidebar"},{"id":"diff/globals","path":"/api/diff/globals","sidebar":"defaultSidebar"},{"id":"docusaurus/globals","path":"/api/docusaurus/globals","sidebar":"defaultSidebar"},{"id":"graphql/directive","path":"/api/graphql/directive","sidebar":"defaultSidebar"},{"id":"graphql/formatter","path":"/api/graphql/formatter","sidebar":"defaultSidebar"},{"id":"graphql/group","path":"/api/graphql/group","sidebar":"defaultSidebar"},{"id":"graphql/guard","path":"/api/graphql/guard","sidebar":"defaultSidebar"},{"id":"graphql/introspection","path":"/api/graphql/introspection","sidebar":"defaultSidebar"},{"id":"graphql/loader","path":"/api/graphql/loader","sidebar":"defaultSidebar"},{"id":"graphql/relation","path":"/api/graphql/relation","sidebar":"defaultSidebar"},{"id":"helpers/directives/descriptor","path":"/api/helpers/directives/descriptor","sidebar":"defaultSidebar"},{"id":"helpers/directives/tag","path":"/api/helpers/directives/tag","sidebar":"defaultSidebar"},{"id":"helpers/utils/interpolate","path":"/api/helpers/utils/interpolate","sidebar":"defaultSidebar"},{"id":"index","path":"/api/","sidebar":"defaultSidebar"},{"id":"logger/globals","path":"/api/logger/globals","sidebar":"defaultSidebar"},{"id":"printer-legacy/badge","path":"/api/printer-legacy/badge","sidebar":"defaultSidebar"},{"id":"printer-legacy/code","path":"/api/printer-legacy/code","sidebar":"defaultSidebar"},{"id":"printer-legacy/common","path":"/api/printer-legacy/common","sidebar":"defaultSidebar"},{"id":"printer-legacy/const/mdx","path":"/api/printer-legacy/const/mdx","sidebar":"defaultSidebar"},{"id":"printer-legacy/const/options","path":"/api/printer-legacy/const/options","sidebar":"defaultSidebar"},{"id":"printer-legacy/const/strings","path":"/api/printer-legacy/const/strings","sidebar":"defaultSidebar"},{"id":"printer-legacy/directive","path":"/api/printer-legacy/directive","sidebar":"defaultSidebar"},{"id":"printer-legacy/example","path":"/api/printer-legacy/example","sidebar":"defaultSidebar"},{"id":"printer-legacy/frontmatter","path":"/api/printer-legacy/frontmatter","sidebar":"defaultSidebar"},{"id":"printer-legacy/graphql/directive","path":"/api/printer-legacy/graphql/directive","sidebar":"defaultSidebar"},{"id":"printer-legacy/graphql/enum","path":"/api/printer-legacy/graphql/enum","sidebar":"defaultSidebar"},{"id":"printer-legacy/graphql/input","path":"/api/printer-legacy/graphql/input","sidebar":"defaultSidebar"},{"id":"printer-legacy/graphql/interface","path":"/api/printer-legacy/graphql/interface","sidebar":"defaultSidebar"},{"id":"printer-legacy/graphql/object","path":"/api/printer-legacy/graphql/object","sidebar":"defaultSidebar"},{"id":"printer-legacy/graphql/operation","path":"/api/printer-legacy/graphql/operation","sidebar":"defaultSidebar"},{"id":"printer-legacy/graphql/scalar","path":"/api/printer-legacy/graphql/scalar","sidebar":"defaultSidebar"},{"id":"printer-legacy/graphql/union","path":"/api/printer-legacy/graphql/union","sidebar":"defaultSidebar"},{"id":"printer-legacy/group","path":"/api/printer-legacy/group","sidebar":"defaultSidebar"},{"id":"printer-legacy/link","path":"/api/printer-legacy/link","sidebar":"defaultSidebar"},{"id":"printer-legacy/printer","path":"/api/printer-legacy/printer","sidebar":"defaultSidebar"},{"id":"printer-legacy/relation","path":"/api/printer-legacy/relation","sidebar":"defaultSidebar"},{"id":"printer-legacy/section","path":"/api/printer-legacy/section","sidebar":"defaultSidebar"},{"id":"types/globals","path":"/api/types/globals","sidebar":"defaultSidebar"},{"id":"utils/array","path":"/api/utils/array","sidebar":"defaultSidebar"},{"id":"utils/fs","path":"/api/utils/fs","sidebar":"defaultSidebar"},{"id":"utils/object","path":"/api/utils/object","sidebar":"defaultSidebar"},{"id":"utils/prettier","path":"/api/utils/prettier","sidebar":"defaultSidebar"},{"id":"utils/string","path":"/api/utils/string","sidebar":"defaultSidebar"},{"id":"utils/url","path":"/api/utils/url","sidebar":"defaultSidebar"},{"id":"/category/graphql-markdowncore","path":"/api/category/graphql-markdowncore","sidebar":"defaultSidebar"},{"id":"/category/graphql-markdowndiff","path":"/api/category/graphql-markdowndiff","sidebar":"defaultSidebar"},{"id":"/category/graphql-markdowndocusaurus","path":"/api/category/graphql-markdowndocusaurus","sidebar":"defaultSidebar"},{"id":"/category/graphql-markdowngraphql","path":"/api/category/graphql-markdowngraphql","sidebar":"defaultSidebar"},{"id":"/category/graphql-markdownhelpers","path":"/api/category/graphql-markdownhelpers","sidebar":"defaultSidebar"},{"id":"/category/directives","path":"/api/category/directives","sidebar":"defaultSidebar"},{"id":"/category/utils","path":"/api/category/utils","sidebar":"defaultSidebar"},{"id":"/category/graphql-markdownlogger","path":"/api/category/graphql-markdownlogger","sidebar":"defaultSidebar"},{"id":"/category/graphql-markdownprinter-legacy","path":"/api/category/graphql-markdownprinter-legacy","sidebar":"defaultSidebar"},{"id":"/category/const","path":"/api/category/const","sidebar":"defaultSidebar"},{"id":"/category/graphql","path":"/api/category/graphql","sidebar":"defaultSidebar"},{"id":"/category/graphql-markdowntypes","path":"/api/category/graphql-markdowntypes","sidebar":"defaultSidebar"},{"id":"/category/graphql-markdownutils","path":"/api/category/graphql-markdownutils","sidebar":"defaultSidebar"}],"draftIds":[],"sidebars":{"defaultSidebar":{"link":{"path":"/api/","label":"index"}}}}],"breadcrumbs":true}}}'),o=JSON.parse('{"defaultLocale":"en","locales":["en"],"path":"i18n","currentLocale":"en","localeConfigs":{"en":{"label":"English","direction":"ltr","htmlLang":"en","calendar":"gregory","path":"en"}}}');var s=n(22654);const l=JSON.parse('{"docusaurusVersion":"3.1.1","siteVersion":"1.0.0","pluginVersions":{"docusaurus-plugin-content-docs":{"type":"package","name":"@docusaurus/plugin-content-docs","version":"3.1.1"},"docusaurus-plugin-content-blog":{"type":"package","name":"@docusaurus/plugin-content-blog","version":"3.1.1"},"docusaurus-plugin-content-pages":{"type":"package","name":"@docusaurus/plugin-content-pages","version":"3.1.1"},"docusaurus-plugin-sitemap":{"type":"package","name":"@docusaurus/plugin-sitemap","version":"3.1.1"},"docusaurus-theme-classic":{"type":"package","name":"@docusaurus/theme-classic","version":"3.1.1"},"@cmfcmf/docusaurus-search-local":{"type":"package","name":"@cmfcmf/docusaurus-search-local","version":"1.1.0"}}}');var c=n(74848);const u={siteConfig:r.default,siteMetadata:l,globalData:i,i18n:o,codeTranslations:s},d=a.createContext(u);function p(e){let{children:t}=e;return(0,c.jsx)(d.Provider,{value:u,children:t})}},33832:(e,t,n)=>{"use strict";n.d(t,{A:()=>m});var a=n(96540),r=n(31712),i=n(21141),o=n(64609),s=n(67685),l=n(74848);function c(e){let{error:t,tryAgain:n}=e;return(0,l.jsxs)("div",{style:{display:"flex",flexDirection:"column",justifyContent:"center",alignItems:"flex-start",minHeight:"100vh",width:"100%",maxWidth:"80ch",fontSize:"20px",margin:"0 auto",padding:"1rem"},children:[(0,l.jsx)("h1",{style:{fontSize:"3rem"},children:"This page crashed"}),(0,l.jsx)("button",{type:"button",onClick:n,style:{margin:"1rem 0",fontSize:"2rem",cursor:"pointer",borderRadius:20,padding:"1rem"},children:"Try again"}),(0,l.jsx)(u,{error:t})]})}function u(e){let{error:t}=e;const n=(0,o.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,l.jsx)("p",{style:{whiteSpace:"pre-wrap"},children:n})}function d(e){let{error:t,tryAgain:n}=e;return(0,l.jsxs)(m,{fallback:()=>(0,l.jsx)(c,{error:t,tryAgain:n}),children:[(0,l.jsx)(i.A,{children:(0,l.jsx)("title",{children:"Page Error"})}),(0,l.jsx)(s.A,{children:(0,l.jsx)(c,{error:t,tryAgain:n})})]})}const p=e=>(0,l.jsx)(d,{...e});class m extends a.Component{constructor(e){super(e),this.state={error:null}}componentDidCatch(e){r.A.canUseDOM&&this.setState({error:e})}render(){const{children:e}=this.props,{error:t}=this.state;if(t){const e={error:t,tryAgain:()=>this.setState({error:null})};return(this.props.fallback??p)(e)}return e??null}}},31712:(e,t,n)=>{"use strict";n.d(t,{A:()=>r});const a="undefined"!=typeof window&&"document"in window&&"createElement"in window.document,r={canUseDOM:a,canUseEventListeners:a&&("addEventListener"in window||"attachEvent"in window),canUseIntersectionObserver:a&&"IntersectionObserver"in window,canUseViewport:a&&"screen"in window}},21141:(e,t,n)=>{"use strict";n.d(t,{A:()=>i});n(96540);var a=n(80545),r=n(74848);function i(e){return(0,r.jsx)(a.mg,{...e})}},14783:(e,t,n)=>{"use strict";n.d(t,{A:()=>m});var a=n(96540),r=n(54625),i=n(64609),o=n(97639),s=n(40877),l=n(31712),c=n(37344),u=n(98180),d=n(74848);function p(e,t){let{isNavLink:n,to:p,href:m,activeClassName:f,isActive:h,"data-noBrokenLinkCheck":b,autoAddBaseUrl:y=!0,...g}=e;const{siteConfig:{trailingSlash:v,baseUrl:x}}=(0,o.A)(),{withBaseUrl:w}=(0,u.h)(),S=(0,c.A)(),_=(0,a.useRef)(null);(0,a.useImperativeHandle)(t,(()=>_.current));const k=p||m;const j=(0,s.A)(k),E=k?.replace("pathname://","");let O=void 0!==E?(C=E,y&&(e=>e.startsWith("/"))(C)?w(C):C):void 0;var C;O&&j&&(O=(0,i.applyTrailingSlash)(O,{trailingSlash:v,baseUrl:x}));const P=(0,a.useRef)(!1),A=n?r.k2:r.N_,T=l.A.canUseIntersectionObserver,I=(0,a.useRef)(),N=()=>{P.current||null==O||(window.docusaurus.preload(O),P.current=!0)};(0,a.useEffect)((()=>(!T&&j&&null!=O&&window.docusaurus.prefetch(O),()=>{T&&I.current&&I.current.disconnect()})),[I,O,T,j]);const R=O?.startsWith("#")??!1,L=!g.target||"_self"===g.target,D=!O||!j||!L||R;return b||!R&&D||S.collectLink(O),g.id&&S.collectAnchor(g.id),D?(0,d.jsx)("a",{ref:_,href:O,...k&&!j&&{target:"_blank",rel:"noopener noreferrer"},...g}):(0,d.jsx)(A,{...g,onMouseEnter:N,onTouchStart:N,innerRef:e=>{_.current=e,T&&e&&j&&(I.current=new window.IntersectionObserver((t=>{t.forEach((t=>{e===t.target&&(t.isIntersecting||t.intersectionRatio>0)&&(I.current.unobserve(e),I.current.disconnect(),null!=O&&window.docusaurus.prefetch(O))}))})),I.current.observe(e))},to:O,...n&&{isActive:h,activeClassName:f}})}const m=a.forwardRef(p)},23230:(e,t,n)=>{"use strict";n.d(t,{A:()=>c,T:()=>l});var a=n(96540),r=n(74848);function i(e,t){const n=e.split(/(\{\w+\})/).map(((e,n)=>{if(n%2==1){const n=t?.[e.slice(1,-1)];if(void 0!==n)return n}return e}));return n.some((e=>(0,a.isValidElement)(e)))?n.map(((e,t)=>(0,a.isValidElement)(e)?a.cloneElement(e,{key:t}):e)).filter((e=>""!==e)):n.join("")}var o=n(22654);function s(e){let{id:t,message:n}=e;if(void 0===t&&void 0===n)throw new Error("Docusaurus translation declarations must have at least a translation id or a default translation message");return o[t??n]??n??t}function l(e,t){let{message:n,id:a}=e;return i(s({message:n,id:a}),t)}function c(e){let{children:t,id:n,values:a}=e;if(t&&"string"!=typeof t)throw console.warn("Illegal children",t),new Error("The Docusaurus component only accept simple string values");const o=s({message:t,id:n});return(0,r.jsx)(r.Fragment,{children:i(o,a)})}},44598:(e,t,n)=>{"use strict";n.d(t,{W:()=>a});const a="default"},40877:(e,t,n)=>{"use strict";function a(e){return/^(?:\w*:|\/\/)/.test(e)}function r(e){return void 0!==e&&!a(e)}n.d(t,{A:()=>r,z:()=>a})},98180:(e,t,n)=>{"use strict";n.d(t,{A:()=>s,h:()=>o});var a=n(96540),r=n(97639),i=n(40877);function o(){const{siteConfig:{baseUrl:e,url:t}}=(0,r.A)(),n=(0,a.useCallback)(((n,a)=>function(e,t,n,a){let{forcePrependBaseUrl:r=!1,absolute:o=!1}=void 0===a?{}:a;if(!n||n.startsWith("#")||(0,i.z)(n))return n;if(r)return t+n.replace(/^\//,"");if(n===t.replace(/\/$/,""))return t;const s=n.startsWith(t)?n:t+n.replace(/^\//,"");return o?e+s:s}(t,e,n,a)),[t,e]);return{withBaseUrl:n}}function s(e,t){void 0===t&&(t={});const{withBaseUrl:n}=o();return n(e,t)}},37344:(e,t,n)=>{"use strict";n.d(t,{A:()=>o});var a=n(96540);n(74848);const r=a.createContext({collectAnchor:()=>{},collectLink:()=>{}}),i=()=>(0,a.useContext)(r);function o(){return i()}},97639:(e,t,n)=>{"use strict";n.d(t,{A:()=>i});var a=n(96540),r=n(53366);function i(){return(0,a.useContext)(r.o)}},26503:(e,t,n)=>{"use strict";n.d(t,{P_:()=>o,kh:()=>i});var a=n(97639),r=n(44598);function i(e,t){void 0===t&&(t={});const n=function(){const{globalData:e}=(0,a.A)();return e}()[e];if(!n&&t.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin.`);return n}function o(e,t,n){void 0===t&&(t=r.W),void 0===n&&(n={});const a=i(e),o=a?.[t];if(!o&&n.failfast)throw new Error(`Docusaurus plugin global data not found for "${e}" plugin with id "${t}".`);return o}},11062:(e,t,n)=>{"use strict";n.d(t,{A:()=>i});var a=n(96540),r=n(48848);function i(){return(0,a.useContext)(r.o)}},36494:(e,t,n)=>{"use strict";n.d(t,{A:()=>r});var a=n(96540);const r=n(31712).A.canUseDOM?a.useLayoutEffect:a.useEffect},81604:(e,t,n)=>{"use strict";n.d(t,{A:()=>r});const a=e=>"object"==typeof e&&!!e&&Object.keys(e).length>0;function r(e){const t={};return function e(n,r){Object.entries(n).forEach((n=>{let[i,o]=n;const s=r?`${r}.${i}`:i;a(o)?e(o,s):t[s]=o}))}(e),t}},23363:(e,t,n)=>{"use strict";n.d(t,{W:()=>o,o:()=>i});var a=n(96540),r=n(74848);const i=a.createContext(null);function o(e){let{children:t,value:n}=e;const o=a.useContext(i),s=(0,a.useMemo)((()=>function(e){let{parent:t,value:n}=e;if(!t){if(!n)throw new Error("Unexpected: no Docusaurus route context found");if(!("plugin"in n))throw new Error("Unexpected: Docusaurus topmost route context has no `plugin` attribute");return n}const a={...t.data,...n?.data};return{plugin:t.plugin,data:a}}({parent:o,value:n})),[o,n]);return(0,r.jsx)(i.Provider,{value:s,children:t})}},19802:(e,t,n)=>{"use strict";n.d(t,{zK:()=>h,vT:()=>d,gk:()=>p,Gy:()=>c,HW:()=>b,ht:()=>u,r7:()=>f,jh:()=>m});var a=n(56347),r=n(26503);const i=e=>e.versions.find((e=>e.isLast));function o(e,t){const n=i(e);return[...e.versions.filter((e=>e!==n)),n].find((e=>!!(0,a.B6)(t,{path:e.path,exact:!1,strict:!1})))}function s(e,t){const n=o(e,t),r=n?.docs.find((e=>!!(0,a.B6)(t,{path:e.path,exact:!0,strict:!1})));return{activeVersion:n,activeDoc:r,alternateDocVersions:r?function(t){const n={};return e.versions.forEach((e=>{e.docs.forEach((a=>{a.id===t&&(n[e.name]=a)}))})),n}(r.id):{}}}const l={},c=()=>(0,r.kh)("docusaurus-plugin-content-docs")??l,u=e=>(0,r.P_)("docusaurus-plugin-content-docs",e,{failfast:!0});function d(e){void 0===e&&(e={});const t=c(),{pathname:n}=(0,a.zy)();return function(e,t,n){void 0===n&&(n={});const r=Object.entries(e).sort(((e,t)=>t[1].path.localeCompare(e[1].path))).find((e=>{let[,n]=e;return!!(0,a.B6)(t,{path:n.path,exact:!1,strict:!1})})),i=r?{pluginId:r[0],pluginData:r[1]}:void 0;if(!i&&n.failfast)throw new Error(`Can't find active docs plugin for "${t}" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: ${Object.values(e).map((e=>e.path)).join(", ")}`);return i}(t,n,e)}function p(e){void 0===e&&(e={});const t=d(e),{pathname:n}=(0,a.zy)();if(!t)return;return{activePlugin:t,activeVersion:o(t.pluginData,n)}}function m(e){return u(e).versions}function f(e){const t=u(e);return i(t)}function h(e){const t=u(e),{pathname:n}=(0,a.zy)();return s(t,n)}function b(e){const t=u(e),{pathname:n}=(0,a.zy)();return function(e,t){const n=i(e);return{latestDocSuggestion:s(e,t).alternateDocVersions[n.name],latestVersionSuggestion:n}}(t,n)}},75729:(e,t,n)=>{"use strict";n.r(t),n.d(t,{default:()=>i});var a=n(5947),r=n.n(a);r().configure({showSpinner:!1});const i={onRouteUpdate(e){let{location:t,previousLocation:n}=e;if(n&&t.pathname!==n.pathname){const e=window.setTimeout((()=>{r().start()}),200);return()=>window.clearTimeout(e)}},onRouteDidUpdate(){r().done()}}},74753:(e,t,n)=>{"use strict";n.r(t);var a=n(78181),r=n(4784);!function(e){const{themeConfig:{prism:t}}=r.default,{additionalLanguages:a}=t;globalThis.Prism=e,a.forEach((e=>{"php"===e&&n(19700),n(18692)(`./prism-${e}`)})),delete globalThis.Prism}(a.My)},85225:(e,t,n)=>{"use strict";n.d(t,{A:()=>u});n(96540);var a=n(18215),r=n(23230),i=n(86957),o=n(14783),s=n(37344);const l={anchorWithStickyNavbar:"anchorWithStickyNavbar_LWe7",anchorWithHideOnScrollNavbar:"anchorWithHideOnScrollNavbar_WYt5"};var c=n(74848);function u(e){let{as:t,id:n,...u}=e;const d=(0,s.A)(),{navbar:{hideOnScroll:p}}=(0,i.p)();if("h1"===t||!n)return(0,c.jsx)(t,{...u,id:void 0});d.collectAnchor(n);const m=(0,r.T)({id:"theme.common.headingLinkTitle",message:"Direct link to {heading}",description:"Title for link to heading"},{heading:"string"==typeof u.children?u.children:n});return(0,c.jsxs)(t,{...u,className:(0,a.A)("anchor",p?l.anchorWithHideOnScrollNavbar:l.anchorWithStickyNavbar,u.className),id:n,children:[u.children,(0,c.jsx)(o.A,{className:"hash-link",to:`#${n}`,"aria-label":m,title:m,children:"\u200b"})]})}},90716:(e,t,n)=>{"use strict";n.d(t,{A:()=>i});n(96540);const a={iconExternalLink:"iconExternalLink_nPIU"};var r=n(74848);function i(e){let{width:t=13.5,height:n=13.5}=e;return(0,r.jsx)("svg",{width:t,height:n,"aria-hidden":"true",viewBox:"0 0 24 24",className:a.iconExternalLink,children:(0,r.jsx)("path",{fill:"currentColor",d:"M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"})})}},67685:(e,t,n)=>{"use strict";n.d(t,{A:()=>lo});var a=n(96540),r=n(18215),i=n(33832),o=n(69817),s=n(56347),l=n(23230),c=n(54067),u=n(74848);const d="__docusaurus_skipToContent_fallback";function p(e){e.setAttribute("tabindex","-1"),e.focus(),e.removeAttribute("tabindex")}function m(){const e=(0,a.useRef)(null),{action:t}=(0,s.W6)(),n=(0,a.useCallback)((e=>{e.preventDefault();const t=document.querySelector("main:first-of-type")??document.getElementById(d);t&&p(t)}),[]);return(0,c.$)((n=>{let{location:a}=n;e.current&&!a.hash&&"PUSH"===t&&p(e.current)})),{containerRef:e,onClick:n}}const f=(0,l.T)({id:"theme.common.skipToMainContent",description:"The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation",message:"Skip to main content"});function h(e){const t=e.children??f,{containerRef:n,onClick:a}=m();return(0,u.jsx)("div",{ref:n,role:"region","aria-label":f,children:(0,u.jsx)("a",{...e,href:`#${d}`,onClick:a,children:t})})}var b=n(18630),y=n(19503);const g={skipToContent:"skipToContent_fXgn"};function v(){return(0,u.jsx)(h,{className:g.skipToContent})}var x=n(86957),w=n(40002);function S(e){let{width:t=21,height:n=21,color:a="currentColor",strokeWidth:r=1.2,className:i,...o}=e;return(0,u.jsx)("svg",{viewBox:"0 0 15 15",width:t,height:n,...o,children:(0,u.jsx)("g",{stroke:a,strokeWidth:r,children:(0,u.jsx)("path",{d:"M.75.75l13.5 13.5M14.25.75L.75 14.25"})})})}const _={closeButton:"closeButton_CVFx"};function k(e){return(0,u.jsx)("button",{type:"button","aria-label":(0,l.T)({id:"theme.AnnouncementBar.closeButtonAriaLabel",message:"Close",description:"The ARIA label for close button of announcement bar"}),...e,className:(0,r.A)("clean-btn close",_.closeButton,e.className),children:(0,u.jsx)(S,{width:14,height:14,strokeWidth:3.1})})}const j={content:"content_knG7"};function E(e){const{announcementBar:t}=(0,x.p)(),{content:n}=t;return(0,u.jsx)("div",{...e,className:(0,r.A)(j.content,e.className),dangerouslySetInnerHTML:{__html:n}})}const O={announcementBar:"announcementBar_mb4j",announcementBarPlaceholder:"announcementBarPlaceholder_vyr4",announcementBarClose:"announcementBarClose_gvF7",announcementBarContent:"announcementBarContent_xLdY"};function C(){const{announcementBar:e}=(0,x.p)(),{isActive:t,close:n}=(0,w.Mj)();if(!t)return null;const{backgroundColor:a,textColor:r,isCloseable:i}=e;return(0,u.jsxs)("div",{className:O.announcementBar,style:{backgroundColor:a,color:r},role:"banner",children:[i&&(0,u.jsx)("div",{className:O.announcementBarPlaceholder}),(0,u.jsx)(E,{className:O.announcementBarContent}),i&&(0,u.jsx)(k,{onClick:n,className:O.announcementBarClose})]})}var P=n(61938),A=n(24245);var T=n(4799),I=n(70763);const N=a.createContext(null);function R(e){let{children:t}=e;const n=function(){const e=(0,P.M)(),t=(0,I.YL)(),[n,r]=(0,a.useState)(!1),i=null!==t.component,o=(0,T.ZC)(i);return(0,a.useEffect)((()=>{i&&!o&&r(!0)}),[i,o]),(0,a.useEffect)((()=>{i?e.shown||r(!0):r(!1)}),[e.shown,i]),(0,a.useMemo)((()=>[n,r]),[n])}();return(0,u.jsx)(N.Provider,{value:n,children:t})}function L(e){if(e.component){const t=e.component;return(0,u.jsx)(t,{...e.props})}}function D(){const e=(0,a.useContext)(N);if(!e)throw new T.dV("NavbarSecondaryMenuDisplayProvider");const[t,n]=e,r=(0,a.useCallback)((()=>n(!1)),[n]),i=(0,I.YL)();return(0,a.useMemo)((()=>({shown:t,hide:r,content:L(i)})),[r,i,t])}function q(e){let{header:t,primaryMenu:n,secondaryMenu:a}=e;const{shown:i}=D();return(0,u.jsxs)("div",{className:"navbar-sidebar",children:[t,(0,u.jsxs)("div",{className:(0,r.A)("navbar-sidebar__items",{"navbar-sidebar__items--show-secondary":i}),children:[(0,u.jsx)("div",{className:"navbar-sidebar__item menu",children:n}),(0,u.jsx)("div",{className:"navbar-sidebar__item menu",children:a})]})]})}var F=n(7710),M=n(11062);function B(e){return(0,u.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,u.jsx)("path",{fill:"currentColor",d:"M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"})})}function z(e){return(0,u.jsx)("svg",{viewBox:"0 0 24 24",width:24,height:24,...e,children:(0,u.jsx)("path",{fill:"currentColor",d:"M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"})})}const U={toggle:"toggle_vylO",toggleButton:"toggleButton_gllP",darkToggleIcon:"darkToggleIcon_wfgR",lightToggleIcon:"lightToggleIcon_pyhR",toggleButtonDisabled:"toggleButtonDisabled_aARS"};function $(e){let{className:t,buttonClassName:n,value:a,onChange:i}=e;const o=(0,M.A)(),s=(0,l.T)({message:"Switch between dark and light mode (currently {mode})",id:"theme.colorToggle.ariaLabel",description:"The ARIA label for the navbar color mode toggle"},{mode:"dark"===a?(0,l.T)({message:"dark mode",id:"theme.colorToggle.ariaLabel.mode.dark",description:"The name for the dark color mode"}):(0,l.T)({message:"light mode",id:"theme.colorToggle.ariaLabel.mode.light",description:"The name for the light color mode"})});return(0,u.jsx)("div",{className:(0,r.A)(U.toggle,t),children:(0,u.jsxs)("button",{className:(0,r.A)("clean-btn",U.toggleButton,!o&&U.toggleButtonDisabled,n),type:"button",onClick:()=>i("dark"===a?"light":"dark"),disabled:!o,title:s,"aria-label":s,"aria-live":"polite",children:[(0,u.jsx)(B,{className:(0,r.A)(U.toggleIcon,U.lightToggleIcon)}),(0,u.jsx)(z,{className:(0,r.A)(U.toggleIcon,U.darkToggleIcon)})]})})}const Q=a.memo($),H={darkNavbarColorModeToggle:"darkNavbarColorModeToggle_X3D1"};function G(e){let{className:t}=e;const n=(0,x.p)().navbar.style,a=(0,x.p)().colorMode.disableSwitch,{colorMode:r,setColorMode:i}=(0,F.G)();return a?null:(0,u.jsx)(Q,{className:t,buttonClassName:"dark"===n?H.darkNavbarColorModeToggle:void 0,value:r,onChange:i})}var V=n(20020);function W(){return(0,u.jsx)(V.A,{className:"navbar__brand",imageClassName:"navbar__logo",titleClassName:"navbar__title text--truncate"})}function K(){const e=(0,P.M)();return(0,u.jsx)("button",{type:"button","aria-label":(0,l.T)({id:"theme.docs.sidebar.closeSidebarButtonAriaLabel",message:"Close navigation bar",description:"The ARIA label for close button of mobile sidebar"}),className:"clean-btn navbar-sidebar__close",onClick:()=>e.toggle(),children:(0,u.jsx)(S,{color:"var(--ifm-color-emphasis-600)"})})}function Y(){return(0,u.jsxs)("div",{className:"navbar-sidebar__brand",children:[(0,u.jsx)(W,{}),(0,u.jsx)(G,{className:"margin-right--md"}),(0,u.jsx)(K,{})]})}var J=n(14783),Z=n(98180),X=n(40877);function ee(e,t){return void 0!==e&&void 0!==t&&new RegExp(e,"gi").test(t)}var te=n(90716);function ne(e){let{activeBasePath:t,activeBaseRegex:n,to:a,href:r,label:i,html:o,isDropdownLink:s,prependBaseUrlToHref:l,...c}=e;const d=(0,Z.A)(a),p=(0,Z.A)(t),m=(0,Z.A)(r,{forcePrependBaseUrl:!0}),f=i&&r&&!(0,X.A)(r),h=o?{dangerouslySetInnerHTML:{__html:o}}:{children:(0,u.jsxs)(u.Fragment,{children:[i,f&&(0,u.jsx)(te.A,{...s&&{width:12,height:12}})]})};return r?(0,u.jsx)(J.A,{href:l?m:r,...c,...h}):(0,u.jsx)(J.A,{to:d,isNavLink:!0,...(t||n)&&{isActive:(e,t)=>n?ee(n,t.pathname):t.pathname.startsWith(p)},...c,...h})}function ae(e){let{className:t,isDropdownItem:n=!1,...a}=e;const i=(0,u.jsx)(ne,{className:(0,r.A)(n?"dropdown__link":"navbar__item navbar__link",t),isDropdownLink:n,...a});return n?(0,u.jsx)("li",{children:i}):i}function re(e){let{className:t,isDropdownItem:n,...a}=e;return(0,u.jsx)("li",{className:"menu__list-item",children:(0,u.jsx)(ne,{className:(0,r.A)("menu__link",t),...a})})}function ie(e){let{mobile:t=!1,position:n,...a}=e;const r=t?re:ae;return(0,u.jsx)(r,{...a,activeClassName:a.activeClassName??(t?"menu__link--active":"navbar__link--active")})}var oe=n(94549),se=n(80260),le=n(97639);const ce={dropdownNavbarItemMobile:"dropdownNavbarItemMobile_S0Fm"};function ue(e,t){return e.some((e=>function(e,t){return!!(0,se.ys)(e.to,t)||!!ee(e.activeBaseRegex,t)||!(!e.activeBasePath||!t.startsWith(e.activeBasePath))}(e,t)))}function de(e){let{items:t,position:n,className:i,onClick:o,...s}=e;const l=(0,a.useRef)(null),[c,d]=(0,a.useState)(!1);return(0,a.useEffect)((()=>{const e=e=>{l.current&&!l.current.contains(e.target)&&d(!1)};return document.addEventListener("mousedown",e),document.addEventListener("touchstart",e),document.addEventListener("focusin",e),()=>{document.removeEventListener("mousedown",e),document.removeEventListener("touchstart",e),document.removeEventListener("focusin",e)}}),[l]),(0,u.jsxs)("div",{ref:l,className:(0,r.A)("navbar__item","dropdown","dropdown--hoverable",{"dropdown--right":"right"===n,"dropdown--show":c}),children:[(0,u.jsx)(ne,{"aria-haspopup":"true","aria-expanded":c,role:"button",href:s.to?void 0:"#",className:(0,r.A)("navbar__link",i),...s,onClick:s.to?void 0:e=>e.preventDefault(),onKeyDown:e=>{"Enter"===e.key&&(e.preventDefault(),d(!c))},children:s.children??s.label}),(0,u.jsx)("ul",{className:"dropdown__menu",children:t.map(((e,t)=>(0,a.createElement)(xi,{isDropdownItem:!0,activeClassName:"dropdown__link--active",...e,key:t})))})]})}function pe(e){let{items:t,className:n,position:i,onClick:o,...l}=e;const c=function(){const{siteConfig:{baseUrl:e}}=(0,le.A)(),{pathname:t}=(0,s.zy)();return t.replace(e,"/")}(),d=ue(t,c),{collapsed:p,toggleCollapsed:m,setCollapsed:f}=(0,oe.u)({initialState:()=>!d});return(0,a.useEffect)((()=>{d&&f(!d)}),[c,d,f]),(0,u.jsxs)("li",{className:(0,r.A)("menu__list-item",{"menu__list-item--collapsed":p}),children:[(0,u.jsx)(ne,{role:"button",className:(0,r.A)(ce.dropdownNavbarItemMobile,"menu__link menu__link--sublist menu__link--sublist-caret",n),...l,onClick:e=>{e.preventDefault(),m()},children:l.children??l.label}),(0,u.jsx)(oe.N,{lazy:!0,as:"ul",className:"menu__list",collapsed:p,children:t.map(((e,t)=>(0,a.createElement)(xi,{mobile:!0,isDropdownItem:!0,onClick:o,activeClassName:"menu__link--active",...e,key:t})))})]})}function me(e){let{mobile:t=!1,...n}=e;const a=t?pe:de;return(0,u.jsx)(a,{...n})}var fe=n(2098);function he(e){let{width:t=20,height:n=20,...a}=e;return(0,u.jsx)("svg",{viewBox:"0 0 24 24",width:t,height:n,"aria-hidden":!0,...a,children:(0,u.jsx)("path",{fill:"currentColor",d:"M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"})})}const be="iconLanguage_nlXk";var ye=n(40961);function ge(e,t){var n=void 0;return function(){for(var a=arguments.length,r=new Array(a),i=0;ie.length)&&(t=e.length);for(var n=0,a=new Array(t);ne.length)&&(t=e.length);for(var n=0,a=new Array(t);n=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}function Ie(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function Ne(e){for(var t=1;t=3||2===n&&a>=4||1===n&&a>=10}(e);function n(n,a,r){if(t&&void 0!==r){var i=r[0].__autocomplete_algoliaCredentials,o={"X-Algolia-Application-Id":i.appId,"X-Algolia-API-Key":i.apiKey};e.apply(void 0,[n].concat(Pe(a),[{headers:o}]))}else e.apply(void 0,[n].concat(Pe(a)))}return{init:function(t,n){e("init",{appId:t,apiKey:n})},setAuthenticatedUserToken:function(t){e("setAuthenticatedUserToken",t)},setUserToken:function(t){e("setUserToken",t)},clickedObjectIDsAfterSearch:function(){for(var e=arguments.length,t=new Array(e),a=0;a0&&n("clickedObjectIDsAfterSearch",Le(t),t[0].items)},clickedObjectIDs:function(){for(var e=arguments.length,t=new Array(e),a=0;a0&&n("clickedObjectIDs",Le(t),t[0].items)},clickedFilters:function(){for(var t=arguments.length,n=new Array(t),a=0;a0&&e.apply(void 0,["clickedFilters"].concat(n))},convertedObjectIDsAfterSearch:function(){for(var e=arguments.length,t=new Array(e),a=0;a0&&n("convertedObjectIDsAfterSearch",Le(t),t[0].items)},convertedObjectIDs:function(){for(var e=arguments.length,t=new Array(e),a=0;a0&&n("convertedObjectIDs",Le(t),t[0].items)},convertedFilters:function(){for(var t=arguments.length,n=new Array(t),a=0;a0&&e.apply(void 0,["convertedFilters"].concat(n))},viewedObjectIDs:function(){for(var e=arguments.length,t=new Array(e),a=0;a0&&t.reduce((function(e,t){var n=t.items,a=Te(t,Oe);return[].concat(Pe(e),Pe(function(e){for(var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:20,n=[],a=0;a0&&e.apply(void 0,["viewedFilters"].concat(n))}}}function qe(e){var t=e.items.reduce((function(e,t){var n;return e[t.__autocomplete_indexName]=(null!==(n=e[t.__autocomplete_indexName])&&void 0!==n?n:[]).concat(t),e}),{});return Object.keys(t).map((function(e){return{index:e,items:t[e],algoliaSource:["autocomplete"]}}))}function Fe(e){return e.objectID&&e.__autocomplete_indexName&&e.__autocomplete_queryID}function Me(e){return Me="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},Me(e)}function Be(e){return function(e){if(Array.isArray(e))return ze(e)}(e)||function(e){if("undefined"!=typeof Symbol&&null!=e[Symbol.iterator]||null!=e["@@iterator"])return Array.from(e)}(e)||function(e,t){if(!e)return;if("string"==typeof e)return ze(e,t);var n=Object.prototype.toString.call(e).slice(8,-1);"Object"===n&&e.constructor&&(n=e.constructor.name);if("Map"===n||"Set"===n)return Array.from(e);if("Arguments"===n||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n))return ze(e,t)}(e)||function(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function ze(e,t){(null==t||t>e.length)&&(t=e.length);for(var n=0,a=new Array(t);n0&&Ve({onItemsChange:r,items:n,insights:c,state:t}))}}),0);return{name:"aa.algoliaInsightsPlugin",subscribe:function(e){var t=e.setContext,n=e.onSelect,a=e.onActive,r=!1;function u(e){t({algoliaInsightsPlugin:{__algoliaSearchParameters:$e($e({},s?{clickAnalytics:!0}:{}),e?{userToken:Ye(e)}:{}),insights:c}})}l("addAlgoliaAgent","insights-plugin"),u(),l("onUserTokenChange",(function(e){r||u(e)})),l("getUserToken",null,(function(e,t){r||u(t)})),l("onAuthenticatedUserTokenChange",(function(e){e?(r=!0,u(e)):(r=!1,l("getUserToken",null,(function(e,t){return u(t)})))})),l("getAuthenticatedUserToken",null,(function(e,t){t&&(r=!0,u(t))})),n((function(e){var t=e.item,n=e.state,a=e.event,r=e.source;Fe(t)&&i({state:n,event:a,insights:c,item:t,insightsEvents:[$e({eventName:"Item Selected"},_e({item:t,items:r.getItems().filter(Fe)}))]})})),a((function(e){var t=e.item,n=e.source,a=e.state,r=e.event;Fe(t)&&o({state:a,event:r,insights:c,item:t,insightsEvents:[$e({eventName:"Item Active"},_e({item:t,items:n.getItems().filter(Fe)}))]})}))},onStateChange:function(e){var t=e.state;d({state:t})},__autocomplete_pluginOptions:e}}function Ke(){var e,t=arguments.length>1?arguments[1]:void 0;return[].concat(Be(arguments.length>0&&void 0!==arguments[0]?arguments[0]:[]),["autocomplete-internal"],Be(null!==(e=t.algoliaInsightsPlugin)&&void 0!==e&&e.__automaticInsights?["autocomplete-automatic"]:[]))}function Ye(e){return"number"==typeof e?e.toString():e}function Je(e){return Je="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},Je(e)}function Ze(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function Xe(e,t,n){return(t=function(e){var t=function(e,t){if("object"!==Je(e)||null===e)return e;var n=e[Symbol.toPrimitive];if(void 0!==n){var a=n.call(e,t||"default");if("object"!==Je(a))return a;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"===Je(t)?t:String(t)}(t))in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function et(e,t,n){var a,r=t.initialState;return{getState:function(){return r},dispatch:function(a,i){var o=function(e){for(var t=1;te.length)&&(t=e.length);for(var n=0,a=new Array(t);n0},reshape:function(e){return e.sources}},e),{},{id:null!==(n=e.id)&&void 0!==n?n:lt(),plugins:r,initialState:yt({activeItemId:null,query:"",completion:null,collections:[],isOpen:!1,status:"idle",context:{}},e.initialState),onStateChange:function(t){var n;null===(n=e.onStateChange)||void 0===n||n.call(e,t),r.forEach((function(e){var n;return null===(n=e.onStateChange)||void 0===n?void 0:n.call(e,t)}))},onSubmit:function(t){var n;null===(n=e.onSubmit)||void 0===n||n.call(e,t),r.forEach((function(e){var n;return null===(n=e.onSubmit)||void 0===n?void 0:n.call(e,t)}))},onReset:function(t){var n;null===(n=e.onReset)||void 0===n||n.call(e,t),r.forEach((function(e){var n;return null===(n=e.onReset)||void 0===n?void 0:n.call(e,t)}))},getSources:function(n){return Promise.all([].concat(ft(r.map((function(e){return e.getSources}))),[e.getSources]).filter(Boolean).map((function(e){return function(e,t){var n=[];return Promise.resolve(e(t)).then((function(e){return Array.isArray(e),Promise.all(e.filter((function(e){return Boolean(e)})).map((function(e){if(e.sourceId,n.includes(e.sourceId))throw new Error("[Autocomplete] The `sourceId` ".concat(JSON.stringify(e.sourceId)," is not unique."));n.push(e.sourceId);var t={getItemInputValue:function(e){return e.state.query},getItemUrl:function(){},onSelect:function(e){(0,e.setIsOpen)(!1)},onActive:Se,onResolve:Se};Object.keys(t).forEach((function(e){t[e].__default=!0}));var a=ut(ut({},t),e);return Promise.resolve(a)})))}))}(e,n)}))).then((function(e){return tt(e)})).then((function(e){return e.map((function(e){return yt(yt({},e),{},{onSelect:function(n){e.onSelect(n),t.forEach((function(e){var t;return null===(t=e.onSelect)||void 0===t?void 0:t.call(e,n)}))},onActive:function(n){e.onActive(n),t.forEach((function(e){var t;return null===(t=e.onActive)||void 0===t?void 0:t.call(e,n)}))},onResolve:function(n){e.onResolve(n),t.forEach((function(e){var t;return null===(t=e.onResolve)||void 0===t?void 0:t.call(e,n)}))}})}))}))},navigator:yt({navigate:function(e){var t=e.itemUrl;a.location.assign(t)},navigateNewTab:function(e){var t=e.itemUrl,n=a.open(t,"_blank","noopener");null==n||n.focus()},navigateNewWindow:function(e){var t=e.itemUrl;a.open(t,"_blank","noopener")}},e.navigator)})}function xt(e){return xt="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},xt(e)}function wt(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function St(e){for(var t=1;te.length)&&(t=e.length);for(var n=0,a=new Array(t);n=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var Ht,Gt,Vt,Wt=null,Kt=(Ht=-1,Gt=-1,Vt=void 0,function(e){var t=++Ht;return Promise.resolve(e).then((function(e){return Vt&&t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var rn=/((gt|sm)-|galaxy nexus)|samsung[- ]|samsungbrowser/i;function on(e){return e.nativeEvent||e}function sn(e){return sn="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},sn(e)}var ln=["props","refresh","store"],cn=["inputElement","formElement","panelElement"],un=["inputElement"],dn=["inputElement","maxLength"],pn=["source"],mn=["item","source"];function fn(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function hn(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}function gn(e){var t=e.props,n=e.refresh,a=e.store,r=yn(e,ln);return{getEnvironmentProps:function(e){var n=e.inputElement,r=e.formElement,i=e.panelElement;function o(e){!a.getState().isOpen&&a.pendingRequests.isEmpty()||e.target===n||!1===[r,i].some((function(t){return n=t,a=e.target,n===a||n.contains(a);var n,a}))&&(a.dispatch("blur",null),t.debug||a.pendingRequests.cancelAll())}return hn({onTouchStart:o,onMouseDown:o,onTouchMove:function(e){!1!==a.getState().isOpen&&n===t.environment.document.activeElement&&e.target!==n&&n.blur()}},yn(e,cn))},getRootProps:function(e){return hn({role:"combobox","aria-expanded":a.getState().isOpen,"aria-haspopup":"listbox","aria-owns":a.getState().isOpen?a.getState().collections.map((function(e){var n=e.source;return Jt(t.id,"list",n)})).join(" "):void 0,"aria-labelledby":Jt(t.id,"label")},e)},getFormProps:function(e){e.inputElement;return hn({action:"",noValidate:!0,role:"search",onSubmit:function(i){var o;i.preventDefault(),t.onSubmit(hn({event:i,refresh:n,state:a.getState()},r)),a.dispatch("submit",null),null===(o=e.inputElement)||void 0===o||o.blur()},onReset:function(i){var o;i.preventDefault(),t.onReset(hn({event:i,refresh:n,state:a.getState()},r)),a.dispatch("reset",null),null===(o=e.inputElement)||void 0===o||o.focus()}},yn(e,un))},getLabelProps:function(e){return hn({htmlFor:Jt(t.id,"input"),id:Jt(t.id,"label")},e)},getInputProps:function(e){var i;function o(e){(t.openOnFocus||Boolean(a.getState().query))&&Yt(hn({event:e,props:t,query:a.getState().completion||a.getState().query,refresh:n,store:a},r)),a.dispatch("focus",null)}var s=e||{},l=(s.inputElement,s.maxLength),c=void 0===l?512:l,u=yn(s,dn),d=Ft(a.getState()),p=function(e){return Boolean(e&&e.match(rn))}((null===(i=t.environment.navigator)||void 0===i?void 0:i.userAgent)||""),m=t.enterKeyHint||(null!=d&&d.itemUrl&&!p?"go":"search");return hn({"aria-autocomplete":"both","aria-activedescendant":a.getState().isOpen&&null!==a.getState().activeItemId?Jt(t.id,"item-".concat(a.getState().activeItemId),null==d?void 0:d.source):void 0,"aria-controls":a.getState().isOpen?a.getState().collections.map((function(e){var n=e.source;return Jt(t.id,"list",n)})).join(" "):void 0,"aria-labelledby":Jt(t.id,"label"),value:a.getState().completion||a.getState().query,id:Jt(t.id,"input"),autoComplete:"off",autoCorrect:"off",autoCapitalize:"off",enterKeyHint:m,spellCheck:"false",autoFocus:t.autoFocus,placeholder:t.placeholder,maxLength:c,type:"search",onChange:function(e){var i=e.currentTarget.value;t.ignoreCompositionEvents&&on(e).isComposing?r.setQuery(i):Yt(hn({event:e,props:t,query:i.slice(0,c),refresh:n,store:a},r))},onCompositionEnd:function(e){Yt(hn({event:e,props:t,query:e.currentTarget.value.slice(0,c),refresh:n,store:a},r))},onKeyDown:function(e){on(e).isComposing||function(e){var t=e.event,n=e.props,a=e.refresh,r=e.store,i=an(e,Xt);if("ArrowUp"===t.key||"ArrowDown"===t.key){var o=function(){var e=Ft(r.getState()),t=n.environment.document.getElementById(Jt(n.id,"item-".concat(r.getState().activeItemId),null==e?void 0:e.source));t&&(t.scrollIntoViewIfNeeded?t.scrollIntoViewIfNeeded(!1):t.scrollIntoView(!1))},s=function(){var e=Ft(r.getState());if(null!==r.getState().activeItemId&&e){var n=e.item,o=e.itemInputValue,s=e.itemUrl,l=e.source;l.onActive(tn({event:t,item:n,itemInputValue:o,itemUrl:s,refresh:a,source:l,state:r.getState()},i))}};t.preventDefault(),!1===r.getState().isOpen&&(n.openOnFocus||Boolean(r.getState().query))?Yt(tn({event:t,props:n,query:r.getState().query,refresh:a,store:r},i)).then((function(){r.dispatch(t.key,{nextActiveItemId:n.defaultActiveItemId}),s(),setTimeout(o,0)})):(r.dispatch(t.key,{}),s(),o())}else if("Escape"===t.key)t.preventDefault(),r.dispatch(t.key,null),r.pendingRequests.cancelAll();else if("Tab"===t.key)r.dispatch("blur",null),r.pendingRequests.cancelAll();else if("Enter"===t.key){if(null===r.getState().activeItemId||r.getState().collections.every((function(e){return 0===e.items.length})))return void(n.debug||r.pendingRequests.cancelAll());t.preventDefault();var l=Ft(r.getState()),c=l.item,u=l.itemInputValue,d=l.itemUrl,p=l.source;if(t.metaKey||t.ctrlKey)void 0!==d&&(p.onSelect(tn({event:t,item:c,itemInputValue:u,itemUrl:d,refresh:a,source:p,state:r.getState()},i)),n.navigator.navigateNewTab({itemUrl:d,item:c,state:r.getState()}));else if(t.shiftKey)void 0!==d&&(p.onSelect(tn({event:t,item:c,itemInputValue:u,itemUrl:d,refresh:a,source:p,state:r.getState()},i)),n.navigator.navigateNewWindow({itemUrl:d,item:c,state:r.getState()}));else if(t.altKey);else{if(void 0!==d)return p.onSelect(tn({event:t,item:c,itemInputValue:u,itemUrl:d,refresh:a,source:p,state:r.getState()},i)),void n.navigator.navigate({itemUrl:d,item:c,state:r.getState()});Yt(tn({event:t,nextState:{isOpen:!1},props:n,query:u,refresh:a,store:r},i)).then((function(){p.onSelect(tn({event:t,item:c,itemInputValue:u,itemUrl:d,refresh:a,source:p,state:r.getState()},i))}))}}}(hn({event:e,props:t,refresh:n,store:a},r))},onFocus:o,onBlur:Se,onClick:function(n){e.inputElement!==t.environment.document.activeElement||a.getState().isOpen||o(n)}},u)},getPanelProps:function(e){return hn({onMouseDown:function(e){e.preventDefault()},onMouseLeave:function(){a.dispatch("mouseleave",null)}},e)},getListProps:function(e){var n=e||{},a=n.source,r=yn(n,pn);return hn({role:"listbox","aria-labelledby":Jt(t.id,"label"),id:Jt(t.id,"list",a)},r)},getItemProps:function(e){var i=e.item,o=e.source,s=yn(e,mn);return hn({id:Jt(t.id,"item-".concat(i.__autocomplete_id),o),role:"option","aria-selected":a.getState().activeItemId===i.__autocomplete_id,onMouseMove:function(e){if(i.__autocomplete_id!==a.getState().activeItemId){a.dispatch("mousemove",i.__autocomplete_id);var t=Ft(a.getState());if(null!==a.getState().activeItemId&&t){var o=t.item,s=t.itemInputValue,l=t.itemUrl,c=t.source;c.onActive(hn({event:e,item:o,itemInputValue:s,itemUrl:l,refresh:n,source:c,state:a.getState()},r))}}},onMouseDown:function(e){e.preventDefault()},onClick:function(e){var s=o.getItemInputValue({item:i,state:a.getState()}),l=o.getItemUrl({item:i,state:a.getState()});(l?Promise.resolve():Yt(hn({event:e,nextState:{isOpen:!1},props:t,query:s,refresh:n,store:a},r))).then((function(){o.onSelect(hn({event:e,item:i,itemInputValue:s,itemUrl:l,refresh:n,source:o,state:a.getState()},r))}))}},s)}}}var vn="1.17.0",xn=[{segment:"autocomplete-core",version:vn}];function wn(e){return wn="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},wn(e)}function Sn(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function _n(e){for(var t=1;t=n?null===a?null:0:r}function Cn(e){return Cn="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},Cn(e)}function Pn(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function An(e){for(var t=1;t=5&&((r||!e&&5===a)&&(o.push(a,0,r,n),a=6),e&&(o.push(a,e,0,n),a=6)),r=""},l=0;l"===t?(a=1,r=""):r=t+r[0]:i?t===i?i="":r+=t:'"'===t||"'"===t?i=t:">"===t?(s(),a=1):a&&("="===t?(a=5,n=r,r=""):"/"===t&&(a<5||">"===e[l][c+1])?(s(),3===a&&(o=o[0]),a=o,(o=o[0]).push(2,0,a),a=0):" "===t||"\t"===t||"\n"===t||"\r"===t?(s(),a=2):r+=t),3===a&&"!--"===r&&(a=4,o=o[0])}return s(),o}(e)),t),arguments,[])).length>1?t:t[0]}var zn=function(e){var t=e.environment,n=t.document.createElementNS("http://www.w3.org/2000/svg","svg");n.setAttribute("class","aa-SubmitIcon"),n.setAttribute("viewBox","0 0 24 24"),n.setAttribute("width","20"),n.setAttribute("height","20"),n.setAttribute("fill","currentColor");var a=t.document.createElementNS("http://www.w3.org/2000/svg","path");return a.setAttribute("d","M16.041 15.856c-0.034 0.026-0.067 0.055-0.099 0.087s-0.060 0.064-0.087 0.099c-1.258 1.213-2.969 1.958-4.855 1.958-1.933 0-3.682-0.782-4.95-2.050s-2.050-3.017-2.050-4.95 0.782-3.682 2.050-4.95 3.017-2.050 4.95-2.050 3.682 0.782 4.95 2.050 2.050 3.017 2.050 4.95c0 1.886-0.745 3.597-1.959 4.856zM21.707 20.293l-3.675-3.675c1.231-1.54 1.968-3.493 1.968-5.618 0-2.485-1.008-4.736-2.636-6.364s-3.879-2.636-6.364-2.636-4.736 1.008-6.364 2.636-2.636 3.879-2.636 6.364 1.008 4.736 2.636 6.364 3.879 2.636 6.364 2.636c2.125 0 4.078-0.737 5.618-1.968l3.675 3.675c0.391 0.391 1.024 0.391 1.414 0s0.391-1.024 0-1.414z"),n.appendChild(a),n},Un=function(e){var t=e.environment,n=t.document.createElementNS("http://www.w3.org/2000/svg","svg");n.setAttribute("class","aa-ClearIcon"),n.setAttribute("viewBox","0 0 24 24"),n.setAttribute("width","18"),n.setAttribute("height","18"),n.setAttribute("fill","currentColor");var a=t.document.createElementNS("http://www.w3.org/2000/svg","path");return a.setAttribute("d","M5.293 6.707l5.293 5.293-5.293 5.293c-0.391 0.391-0.391 1.024 0 1.414s1.024 0.391 1.414 0l5.293-5.293 5.293 5.293c0.391 0.391 1.024 0.391 1.414 0s0.391-1.024 0-1.414l-5.293-5.293 5.293-5.293c0.391-0.391 0.391-1.024 0-1.414s-1.024-0.391-1.414 0l-5.293 5.293-5.293-5.293c-0.391-0.391-1.024-0.391-1.414 0s-0.391 1.024 0 1.414z"),n.appendChild(a),n},$n=function(e){var t=e.environment.document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("class","aa-LoadingIcon"),t.setAttribute("viewBox","0 0 100 100"),t.setAttribute("width","20"),t.setAttribute("height","20"),t.innerHTML='\n \n',t},Qn=["ontouchstart","ontouchend","ontouchmove","ontouchcancel"];function Hn(e,t,n){e[t]=null===n?"":"number"!=typeof n?n:n+"px"}function Gn(e){this._listeners[e.type](e)}function Vn(e,t,n){var a,r,i=e[t];if("style"===t)if("string"==typeof n)e.style=n;else if(null===n)e.style="";else for(t in n)i&&n[t]===i[t]||Hn(e.style,t,n[t]);else"o"===t[0]&&"n"===t[1]?(a=t!==(t=t.replace(/Capture$/,"")),((r=t.toLowerCase())in e||Qn.includes(r))&&(t=r),t=t.slice(2),e._listeners||(e._listeners={}),e._listeners[t]=n,n?i||e.addEventListener(t,Gn,a):e.removeEventListener(t,Gn,a)):"list"!==t&&"tagName"!==t&&"form"!==t&&"type"!==t&&"size"!==t&&"download"!==t&&"href"!==t&&t in e?e[t]=null==n?"":n:"function"!=typeof n&&"dangerouslySetInnerHTML"!==t&&(null==n||!1===n&&!/^ar/.test(t)?e.removeAttribute(t):e.setAttribute(t,n))}function Wn(e){switch(e){case"onChange":return"onInput";case"onCompositionEnd":return"oncompositionend";default:return e}}function Kn(e,t){for(var n in t)Vn(e,Wn(n),t[n])}function Yn(e,t){for(var n in t)"o"===n[0]&&"n"===n[1]||Vn(e,Wn(n),t[n])}var Jn=["children"];function Zn(e){return function(e){if(Array.isArray(e))return Xn(e)}(e)||function(e){if("undefined"!=typeof Symbol&&null!=e[Symbol.iterator]||null!=e["@@iterator"])return Array.from(e)}(e)||function(e,t){if(!e)return;if("string"==typeof e)return Xn(e,t);var n=Object.prototype.toString.call(e).slice(8,-1);"Object"===n&&e.constructor&&(n=e.constructor.name);if("Map"===n||"Set"===n)return Array.from(e);if("Arguments"===n||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n))return Xn(e,t)}(e)||function(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function Xn(e,t){(null==t||t>e.length)&&(t=e.length);for(var n=0,a=new Array(t);n=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}function ta(e){return function(t,n){var a=n.children,r=void 0===a?[]:a,i=ea(n,Jn),o=e.document.createElement(t);return Kn(o,i),o.append.apply(o,Zn(r)),o}}function na(e){return na="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},na(e)}var aa=["autocompleteScopeApi","environment","classNames","getInputProps","getInputPropsCore","isDetached","state"];function ra(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function ia(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var la=function(e){var t=e.autocompleteScopeApi,n=e.environment,a=(e.classNames,e.getInputProps),r=e.getInputPropsCore,i=e.isDetached,o=e.state,s=sa(e,aa),l=ta(n)("input",s),c=a(ia({state:o,props:r({inputElement:l}),inputElement:l},t));return Kn(l,ia(ia({},c),{},{onKeyDown:function(e){i&&"Tab"===e.key||c.onKeyDown(e)}})),l};function ca(e){return ca="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},ca(e)}function ua(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function da(e){for(var t=1;t2&&(o.children=arguments.length>3?ma.call(arguments,2):n),"function"==typeof e&&null!=e.defaultProps)for(i in e.defaultProps)void 0===o[i]&&(o[i]=e.defaultProps[i]);return Oa(e,o,a,r,null)}function Oa(e,t,n,a,r){var i={type:e,props:t,key:n,ref:a,__k:null,__:null,__b:0,__e:null,__d:void 0,__c:null,constructor:void 0,__v:null==r?++ha:r,__i:-1,__u:0};return null==r&&null!=fa.vnode&&fa.vnode(i),i}function Ca(e){return e.children}function Pa(e,t){this.props=e,this.context=t}function Aa(e,t){if(null==t)return e.__?Aa(e.__,e.__i+1):null;for(var n;tt&&ba.sort(va));Na.__r=0}function Ra(e,t,n,a,r,i,o,s,l,c,u){var d,p,m,f,h,b=a&&a.__k||wa,y=t.length;for(n.__d=l,La(n,t,b),l=n.__d,d=0;d0?Oa(r.type,r.props,r.key,r.ref?r.ref:null,r.__v):r)?(r.__=e,r.__b=e.__b+1,s=qa(r,n,o,u),r.__i=s,i=null,-1!==s&&(u--,(i=n[s])&&(i.__u|=131072)),null==i||null===i.__v?(-1==s&&d--,"function"!=typeof r.type&&(r.__u|=65536)):s!==o&&(s===o+1?d++:s>o?u>l-o?d+=s-o:d--:s(null==l||131072&l.__u?0:1))for(;o>=0||s=0){if((l=t[o])&&!(131072&l.__u)&&r==l.key&&i===l.type)return o;o--}if(s0&&void 0!==arguments[0]?arguments[0]:[];return{get:function(){return e},add:function(t){var n=e[e.length-1];(null==n?void 0:n.isHighlighted)===t.isHighlighted?e[e.length-1]={value:n.value+t.value,isHighlighted:n.isHighlighted}:e.push(t)}}}(n?[{value:n,isHighlighted:!1}]:[]);return t.forEach((function(e){var t=e.split(Ja);a.add({value:t[0],isHighlighted:!0}),""!==t[1]&&a.add({value:t[1],isHighlighted:!1})})),a.get()}function Xa(e){return function(e){if(Array.isArray(e))return er(e)}(e)||function(e){if("undefined"!=typeof Symbol&&null!=e[Symbol.iterator]||null!=e["@@iterator"])return Array.from(e)}(e)||function(e,t){if(!e)return;if("string"==typeof e)return er(e,t);var n=Object.prototype.toString.call(e).slice(8,-1);"Object"===n&&e.constructor&&(n=e.constructor.name);if("Map"===n||"Set"===n)return Array.from(e);if("Arguments"===n||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n))return er(e,t)}(e)||function(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}()}function er(e,t){(null==t||t>e.length)&&(t=e.length);for(var n=0,a=new Array(t);n",""":'"',"'":"'"},rr=new RegExp(/\w/i),ir=/&(amp|quot|lt|gt|#39);/g,or=RegExp(ir.source);function sr(e,t){var n,a,r,i=e[t],o=(null===(n=e[t+1])||void 0===n?void 0:n.isHighlighted)||!0,s=(null===(a=e[t-1])||void 0===a?void 0:a.isHighlighted)||!0;return rr.test((r=i.value)&&or.test(r)?r.replace(ir,(function(e){return ar[e]})):r)||s!==o?i.isHighlighted:s}function lr(e){return lr="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},lr(e)}function cr(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function ur(e){for(var t=1;te.length)&&(t=e.length);for(var n=0,a=new Array(t);n=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var Or={clearButton:"aa-ClearButton",detachedCancelButton:"aa-DetachedCancelButton",detachedContainer:"aa-DetachedContainer",detachedFormContainer:"aa-DetachedFormContainer",detachedOverlay:"aa-DetachedOverlay",detachedSearchButton:"aa-DetachedSearchButton",detachedSearchButtonIcon:"aa-DetachedSearchButtonIcon",detachedSearchButtonPlaceholder:"aa-DetachedSearchButtonPlaceholder",detachedSearchButtonQuery:"aa-DetachedSearchButtonQuery",form:"aa-Form",input:"aa-Input",inputWrapper:"aa-InputWrapper",inputWrapperPrefix:"aa-InputWrapperPrefix",inputWrapperSuffix:"aa-InputWrapperSuffix",item:"aa-Item",label:"aa-Label",list:"aa-List",loadingIndicator:"aa-LoadingIndicator",panel:"aa-Panel",panelLayout:"aa-PanelLayout aa-Panel--scrollable",root:"aa-Autocomplete",source:"aa-Source",sourceFooter:"aa-SourceFooter",sourceHeader:"aa-SourceHeader",sourceNoResults:"aa-SourceNoResults",submitButton:"aa-SubmitButton"},Cr=function(e,t){var n=e.children;(0,e.render)(n,t)},Pr={createElement:Ea,Fragment:Ca,render:Wa};function Ar(e){var t=e.panelPlacement,n=e.container,a=e.form,r=e.environment,i=n.getBoundingClientRect(),o=(r.pageYOffset||r.document.documentElement.scrollTop||r.document.body.scrollTop||0)+i.top+i.height;switch(t){case"start":return{top:o,left:i.left};case"end":return{top:o,right:r.document.documentElement.clientWidth-(i.left+i.width)};case"full-width":return{top:o,left:0,right:0,width:"unset",maxWidth:"unset"};case"input-wrapper-width":var s=a.getBoundingClientRect();return{top:o,left:s.left,right:r.document.documentElement.clientWidth-(s.left+s.width),width:"unset",maxWidth:"unset"};default:throw new Error("[Autocomplete] The `panelPlacement` value ".concat(JSON.stringify(t)," is not valid."))}}function Tr(e){return Tr="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},Tr(e)}function Ir(){return Ir=Object.assign?Object.assign.bind():function(e){for(var t=1;te.length)&&(t=e.length);for(var n=0,a=new Array(t);ne.length)&&(t=e.length);for(var n=0,a=new Array(t);n=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}function Jr(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function Zr(e){for(var t=1;t0;if(!p.value.core.openOnFocus&&!t.query)return n;var a=Boolean(c.current||p.value.renderer.renderNoResults);return!n&&a||n},__autocomplete_metadata:{userAgents:Dr,options:e}}))})),h=ve(Zr({collections:[],completion:null,context:{},isOpen:!1,query:"",activeItemId:null,status:"idle"},p.value.core.initialState)),b={getEnvironmentProps:p.value.renderer.getEnvironmentProps,getFormProps:p.value.renderer.getFormProps,getInputProps:p.value.renderer.getInputProps,getItemProps:p.value.renderer.getItemProps,getLabelProps:p.value.renderer.getLabelProps,getListProps:p.value.renderer.getListProps,getPanelProps:p.value.renderer.getPanelProps,getRootProps:p.value.renderer.getRootProps},y={setActiveItemId:f.value.setActiveItemId,setQuery:f.value.setQuery,setCollections:f.value.setCollections,setIsOpen:f.value.setIsOpen,setStatus:f.value.setStatus,setContext:f.value.setContext,refresh:f.value.refresh,navigator:f.value.navigator},g=s((function(){return Bn.bind(p.value.renderer.renderer.createElement)})),v=s((function(){return function(e){var t=e.autocomplete,n=e.autocompleteScopeApi,a=e.classNames,r=e.environment,i=e.isDetached,o=e.placeholder,s=void 0===o?"Search":o,l=e.propGetters,c=e.setIsModalOpen,u=e.state,d=e.translations,p=ta(r),m=l.getRootProps(da({state:u,props:t.getRootProps({})},n)),f=p("div",da({class:a.root},m)),h=p("div",{class:a.detachedContainer,onMouseDown:function(e){e.stopPropagation()}}),b=p("div",{class:a.detachedOverlay,children:[h],onMouseDown:function(){c(!1),t.setIsOpen(!1)}}),y=l.getLabelProps(da({state:u,props:t.getLabelProps({})},n)),g=p("button",{class:a.submitButton,type:"submit",title:d.submitButtonTitle,children:[zn({environment:r})]}),v=p("label",da({class:a.label,children:[g]},y)),x=p("button",{class:a.clearButton,type:"reset",title:d.clearButtonTitle,children:[Un({environment:r})]}),w=p("div",{class:a.loadingIndicator,children:[$n({environment:r})]}),S=la({class:a.input,environment:r,state:u,getInputProps:l.getInputProps,getInputPropsCore:t.getInputProps,autocompleteScopeApi:n,isDetached:i}),_=p("div",{class:a.inputWrapperPrefix,children:[v,w]}),k=p("div",{class:a.inputWrapperSuffix,children:[x]}),j=p("div",{class:a.inputWrapper,children:[S]}),E=l.getFormProps(da({state:u,props:t.getFormProps({inputElement:S})},n)),O=p("form",da({class:a.form,children:[_,j,k]},E)),C=l.getPanelProps(da({state:u,props:t.getPanelProps({})},n)),P=p("div",da({class:a.panel},C)),A=p("div",{class:a.detachedSearchButtonQuery,textContent:u.query}),T=p("div",{class:a.detachedSearchButtonPlaceholder,hidden:Boolean(u.query),textContent:s});if(i){var I=p("div",{class:a.detachedSearchButtonIcon,children:[zn({environment:r})]}),N=p("button",{type:"button",class:a.detachedSearchButton,title:d.detachedSearchButtonTitle,id:y.id,onClick:function(){c(!0)},children:[I,T,A]}),R=p("button",{type:"button",class:a.detachedCancelButton,textContent:d.detachedCancelButtonText,onTouchStart:function(e){e.stopPropagation()},onClick:function(){t.setIsOpen(!1),c(!1)}}),L=p("div",{class:a.detachedFormContainer,children:[O,R]});h.appendChild(L),f.appendChild(N)}else f.appendChild(O);return{detachedContainer:h,detachedOverlay:b,detachedSearchButtonQuery:A,detachedSearchButtonPlaceholder:T,inputWrapper:j,input:S,root:f,form:O,label:v,submitButton:g,clearButton:x,loadingIndicator:w,panel:P}}({autocomplete:f.value,autocompleteScopeApi:y,classNames:p.value.renderer.classNames,environment:p.value.core.environment,isDetached:m.value,placeholder:p.value.core.placeholder,propGetters:b,setIsModalOpen:_,state:h.current,translations:p.value.renderer.translations})}));function x(){Kn(v.value.panel,{style:m.value?{}:Ar({panelPlacement:p.value.renderer.panelPlacement,container:v.value.root,form:v.value.form,environment:p.value.core.environment})})}function w(e){h.current=e;var t={autocomplete:f.value,autocompleteScopeApi:y,classNames:p.value.renderer.classNames,components:p.value.renderer.components,container:p.value.renderer.container,html:g.value,dom:v.value,panelContainer:m.value?v.value.detachedContainer:p.value.renderer.panelContainer,propGetters:b,state:h.current,renderer:p.value.renderer.renderer},n=!ot(e)&&!c.current&&p.value.renderer.renderNoResults||p.value.renderer.render;!function(e){var t=e.autocomplete,n=e.autocompleteScopeApi,a=e.dom,r=e.propGetters,i=e.state;Yn(a.root,r.getRootProps(Rr({state:i,props:t.getRootProps({})},n))),Yn(a.input,r.getInputProps(Rr({state:i,props:t.getInputProps({inputElement:a.input}),inputElement:a.input},n))),Kn(a.label,{hidden:"stalled"===i.status}),Kn(a.loadingIndicator,{hidden:"stalled"!==i.status}),Kn(a.clearButton,{hidden:!i.query}),Kn(a.detachedSearchButtonQuery,{textContent:i.query}),Kn(a.detachedSearchButtonPlaceholder,{hidden:Boolean(i.query)})}(t),function(e,t){var n=t.autocomplete,a=t.autocompleteScopeApi,r=t.classNames,i=t.html,o=t.dom,s=t.panelContainer,l=t.propGetters,c=t.state,u=t.components,d=t.renderer;if(c.isOpen){s.contains(o.panel)||"loading"===c.status||s.appendChild(o.panel),o.panel.classList.toggle("aa-Panel--stalled","stalled"===c.status);var p=c.collections.filter((function(e){var t=e.source,n=e.items;return t.templates.noResults||n.length>0})).map((function(e,t){var o=e.source,s=e.items;return d.createElement("section",{key:t,className:r.source,"data-autocomplete-source-id":o.sourceId},o.templates.header&&d.createElement("div",{className:r.sourceHeader},o.templates.header({components:u,createElement:d.createElement,Fragment:d.Fragment,items:s,source:o,state:c,html:i})),o.templates.noResults&&0===s.length?d.createElement("div",{className:r.sourceNoResults},o.templates.noResults({components:u,createElement:d.createElement,Fragment:d.Fragment,source:o,state:c,html:i})):d.createElement("ul",Ir({className:r.list},l.getListProps(Rr({state:c,props:n.getListProps({source:o})},a))),s.map((function(e){var t=n.getItemProps({item:e,source:o});return d.createElement("li",Ir({key:t.id,className:r.item},l.getItemProps(Rr({state:c,props:t},a))),o.templates.item({components:u,createElement:d.createElement,Fragment:d.Fragment,item:e,state:c,html:i}))}))),o.templates.footer&&d.createElement("div",{className:r.sourceFooter},o.templates.footer({components:u,createElement:d.createElement,Fragment:d.Fragment,items:s,source:o,state:c,html:i})))})),m=d.createElement(d.Fragment,null,d.createElement("div",{className:r.panelLayout},p),d.createElement("div",{className:"aa-GradientBottom"})),f=p.reduce((function(e,t){return e[t.props["data-autocomplete-source-id"]]=t,e}),{});e(Rr(Rr({children:m,state:c,sections:p,elements:f},d),{},{components:u,html:i},a),o.panel)}else s.contains(o.panel)&&s.removeChild(o.panel)}(n,t)}function S(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{};r();var t,n,a=p.value.renderer,o=a.components,s=Yr(a,Wr);u.current=zr(s,p.value.core,{components:(t=o,n=function(e){return!e.value.hasOwnProperty("__autocomplete_componentName")},Object.entries(t).reduce((function(e,t){var a=Gr(t,2),r=a[0],i=a[1];return n({key:r,value:i})?Qr(Qr({},e),{},Hr({},r,i)):e}),{})),initialState:h.current},e),l(),i(),f.value.refresh().then((function(){w(h.current)}))}function _(e){e!==p.value.core.environment.document.body.contains(v.value.detachedOverlay)&&(e?(p.value.core.environment.document.body.appendChild(v.value.detachedOverlay),p.value.core.environment.document.body.classList.add("aa-Detached"),v.value.input.focus()):(p.value.core.environment.document.body.removeChild(v.value.detachedOverlay),p.value.core.environment.document.body.classList.remove("aa-Detached")))}return a((function(){var e=f.value.getEnvironmentProps({formElement:v.value.form,panelElement:v.value.panel,inputElement:v.value.input});return Kn(p.value.core.environment,e),function(){Kn(p.value.core.environment,Object.keys(e).reduce((function(e,t){return Zr(Zr({},e),{},Xr({},t,void 0))}),{}))}})),a((function(){var e=m.value?p.value.core.environment.document.body:p.value.renderer.panelContainer,t=m.value?v.value.detachedOverlay:v.value.panel;return m.value&&h.current.isOpen&&_(!0),w(h.current),function(){e.contains(t)&&e.removeChild(t)}})),a((function(){var e=p.value.renderer.container;return e.appendChild(v.value.root),function(){e.removeChild(v.value.root)}})),a((function(){var e=ge((function(e){w(e.state)}),0);return d.current=function(t){var n=t.state,a=t.prevState;(m.value&&a.isOpen!==n.isOpen&&_(n.isOpen),m.value||!n.isOpen||a.isOpen||x(),n.query!==a.query)&&p.value.core.environment.document.querySelectorAll(".aa-Panel--scrollable").forEach((function(e){0!==e.scrollTop&&(e.scrollTop=0)}));e({state:n})},function(){d.current=void 0}})),a((function(){var e=ge((function(){var e=m.value;m.value=p.value.core.environment.matchMedia(p.value.renderer.detachedMediaQuery).matches,e!==m.value?S({}):requestAnimationFrame(x)}),20);return p.value.core.environment.addEventListener("resize",e),function(){p.value.core.environment.removeEventListener("resize",e)}})),a((function(){if(!m.value)return function(){};function e(e){v.value.detachedContainer.classList.toggle("aa-DetachedContainer--modal",e)}function t(t){e(t.matches)}var n=p.value.core.environment.matchMedia(getComputedStyle(p.value.core.environment.document.documentElement).getPropertyValue("--aa-detached-modal-media-query"));e(n.matches);var a=Boolean(n.addEventListener);return a?n.addEventListener("change",t):n.addListener(t),function(){a?n.removeEventListener("change",t):n.removeListener(t)}})),a((function(){return requestAnimationFrame(x),function(){}})),Zr(Zr({},y),{},{update:S,destroy:function(){r()}})}var ti=n(21141);const ni=n(60774),ai=ni;var ri=n(689),ii=n.n(ri);function oi(){const e=(0,s.zy)(),t=(0,s.W6)(),{siteConfig:{baseUrl:n}}=(0,le.A)(),[r,i]=(0,a.useState)({terms:[],isDocsOrBlog:!1});return(0,a.useEffect)((()=>{if(!e.state?.cmfcmfhighlight||0===e.state.cmfcmfhighlight.terms.length)return;i(e.state.cmfcmfhighlight);const{cmfcmfhighlight:n,...a}=e.state;t.replace({...e,state:a})}),[e.state?.cmfcmfhighlight,t,e]),(0,a.useEffect)((()=>{if(0===r.terms.length)return;const e=r.isDocsOrBlog?document.getElementsByTagName("article")[0]:document.getElementsByTagName("main")[0];if(!e)return;const t=new(ii())(e),n={ignoreJoiners:!0};return t.mark(r.terms,n),()=>t.unmark(n)}),[r,n]),null}var si=n(26503),li=n(61482);function ci(e){let{document:t}=e;const[n,a]=t.sectionRoute.split("#");let r=n;return a&&(r+="#"+a),r}const ui={documents:[],index:ai((function(){this.ref("id"),this.field("title"),this.field("content")}))};const di=()=>{const e=(0,M.A)(),[t,n]=(0,a.useState)((()=>!!e&&"dark"===document.documentElement.getAttribute("data-theme")));(0,a.useEffect)((()=>{const e=new MutationObserver((()=>{n("dark"===document.documentElement.getAttribute("data-theme"))}));return e.observe(document.documentElement,{attributes:!0,attributeFilter:["data-theme"]}),()=>e.disconnect()}),[]);const{siteConfig:{baseUrl:r}}=(0,le.A)(),{titleBoost:i,contentBoost:o,tagsBoost:c,parentCategoriesBoost:u,indexDocSidebarParentCategories:d,maxSearchResults:p}=(0,si.P_)("@cmfcmf/docusaurus-search-local"),m=(0,s.W6)(),{tags:f}=(0,li.af)(),h=(0,a.useRef)(f);(0,a.useEffect)((()=>{h.current=f}),[f]);const b=(0,a.useRef)({}),y=async e=>{const t=b.current[e];switch(t?.state){case"ready":return t;case void 0:{const t=[];b.current[e]={state:"loading",callbacks:t};const n=await async function(e,t){{let a;try{const n=await fetch(`${e}search-index-${t}.json`);if(!n.ok)return ui;a=await n.json()}catch(n){return ui}return{documents:a.documents,index:ai.Index.load(a.index)}}}(r,e);return t.forEach((e=>e(n))),b.current[e]={state:"ready",...n}}case"loading":return new Promise((e=>{t.callbacks.push(e)}))}},g=(0,l.T)({message:"cmfcmf/d-s-l.searchBar.placeholder",description:"Placeholder shown in the searchbar"}),v=(0,a.useRef)(null),x=(0,a.useRef)(null);return(0,a.useEffect)((()=>{if(v.current)return x.current=ei({container:v.current,placeholder:g,renderer:{createElement:a.createElement,Fragment:a.Fragment,render:ye.render},navigator:{navigate(e){let{item:t,itemUrl:n}=e;m.push(n,{cmfcmfhighlight:{terms:t.terms,isDocsOrBlog:"docs"===t.document.type||"blog"===t.document.type}})}},detachedMediaQuery:"",defaultActiveItemId:0,translations:{clearButtonTitle:(0,l.T)({message:"cmfcmf/d-s-l.searchBar.clearButtonTitle",description:"Title of the button to clear the current search input"}),detachedCancelButtonText:(0,l.T)({message:"cmfcmf/d-s-l.searchBar.detachedCancelButtonText",description:"Text of the button to close the detached search window"}),submitButtonTitle:(0,l.T)({message:"cmfcmf/d-s-l.searchBar.submitButtonTitle",description:"Title of the button to submit a new search"})},getSources(e){let{query:t}=e;return[{sourceId:"search-results",templates:{item(e){let{item:t}=e;const n=ci(t);return a.createElement("a",{href:n,className:"aa-ItemLink",onClick:e=>{e.preventDefault(),m.push(n,{cmfcmfhighlight:{terms:t.terms,isDocsOrBlog:"docs"===t.document.type||"blog"===t.document.type}})}},a.createElement("div",{className:"aa-ItemContent"},a.createElement("div",{className:"aa-ItemContentBody"},a.createElement("div",{className:"aa-ItemContentTitle"},t.document.sectionTitle),t.document.pageTitle!==t.document.sectionTitle&&a.createElement("div",{className:"aa-ItemContentDescription"},t.document.pageTitle))),a.createElement("div",{className:"aa-ItemActions"},a.createElement("button",{className:"aa-ItemActionButton aa-DesktopOnly aa-ActiveOnly",type:"button",title:"Select"},a.createElement("svg",{viewBox:"0 0 24 24",width:"20",height:"20",fill:"currentColor"},a.createElement("path",{d:"M18.984 6.984h2.016v6h-15.188l3.609 3.609-1.406 1.406-6-6 6-6 1.406 1.406-3.609 3.609h13.172v-4.031z"})))))},noResults:()=>a.createElement("div",{className:"aa-ItemContent"},a.createElement("div",{className:"aa-ItemContentBody"},(0,l.T)({message:"cmfcmf/d-s-l.searchBar.noResults",description:"message shown if no results are found"})))},getItemUrl(e){let{item:t}=e;return ci(t)},async getItems(){const e=h.current,n=await Promise.all(e.map((e=>y(e)))),a=(e=>ni.tokenizer(e).map((e=>e.str)))(t);return n.flatMap((e=>{let{index:t,documents:n}=e;return t.query((e=>{e.term(a,{fields:["title"],boost:i}),e.term(a,{fields:["title"],boost:i,wildcard:ai.Query.wildcard.TRAILING}),e.term(a,{fields:["content"],boost:o}),e.term(a,{fields:["content"],boost:o,wildcard:ai.Query.wildcard.TRAILING}),e.term(a,{fields:["tags"],boost:c}),e.term(a,{fields:["tags"],boost:c,wildcard:ai.Query.wildcard.TRAILING}),d&&(e.term(a,{fields:["sidebarParentCategories"],boost:u}),e.term(a,{fields:["sidebarParentCategories"],boost:u,wildcard:ai.Query.wildcard.TRAILING}))})).slice(0,p).map((e=>({document:n.find((t=>t.id.toString()===e.ref)),score:e.score,terms:a})))})).sort(((e,t)=>t.score-e.score)).slice(0,p)}}]}}),()=>x.current?.destroy()}),[p]),a.createElement(a.Fragment,null,a.createElement(ti.A,null,a.createElement("body",{"data-theme":t?"dark":"light"})),a.createElement(oi,null),a.createElement("div",{className:"dsla-search-wrapper"},a.createElement("div",{className:"dsla-search-field",ref:v,"data-tags":f.join(",")})))},pi={navbarSearchContainer:"navbarSearchContainer_Bca1"};function mi(e){let{children:t,className:n}=e;return(0,u.jsx)("div",{className:(0,r.A)(n,pi.navbarSearchContainer),children:t})}var fi=n(19802),hi=n(5215);var bi=n(2780);const yi=e=>e.docs.find((t=>t.id===e.mainDocId));const gi={default:ie,localeDropdown:function(e){let{mobile:t,dropdownItemsBefore:n,dropdownItemsAfter:a,queryString:r="",...i}=e;const{i18n:{currentLocale:o,locales:c,localeConfigs:d}}=(0,le.A)(),p=(0,fe.o)(),{search:m,hash:f}=(0,s.zy)(),h=[...n,...c.map((e=>{const n=`${`pathname://${p.createUrl({locale:e,fullyQualified:!1})}`}${m}${f}${r}`;return{label:d[e].label,lang:d[e].htmlLang,to:n,target:"_self",autoAddBaseUrl:!1,className:e===o?t?"menu__link--active":"dropdown__link--active":""}})),...a],b=t?(0,l.T)({message:"Languages",id:"theme.navbar.mobileLanguageDropdown.label",description:"The label for the mobile language switcher dropdown"}):d[o].label;return(0,u.jsx)(me,{...i,mobile:t,label:(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(he,{className:be}),b]}),items:h})},search:function(e){let{mobile:t,className:n}=e;return t?null:(0,u.jsx)(mi,{className:n,children:(0,u.jsx)(di,{})})},dropdown:me,html:function(e){let{value:t,className:n,mobile:a=!1,isDropdownItem:i=!1}=e;const o=i?"li":"div";return(0,u.jsx)(o,{className:(0,r.A)({navbar__item:!a&&!i,"menu__list-item":a},n),dangerouslySetInnerHTML:{__html:t}})},doc:function(e){let{docId:t,label:n,docsPluginId:a,...r}=e;const{activeDoc:i}=(0,fi.zK)(a),o=(0,hi.QB)(t,a),s=i?.path===o?.path;return null===o||o.unlisted&&!s?null:(0,u.jsx)(ie,{exact:!0,...r,isActive:()=>s||!!i?.sidebar&&i.sidebar===o.sidebar,label:n??o.id,to:o.path})},docSidebar:function(e){let{sidebarId:t,label:n,docsPluginId:a,...r}=e;const{activeDoc:i}=(0,fi.zK)(a),o=(0,hi.fW)(t,a).link;if(!o)throw new Error(`DocSidebarNavbarItem: Sidebar with ID "${t}" doesn't have anything to be linked to.`);return(0,u.jsx)(ie,{exact:!0,...r,isActive:()=>i?.sidebar===t,label:n??o.label,to:o.path})},docsVersion:function(e){let{label:t,to:n,docsPluginId:a,...r}=e;const i=(0,hi.Vd)(a)[0],o=t??i.label,s=n??(e=>e.docs.find((t=>t.id===e.mainDocId)))(i).path;return(0,u.jsx)(ie,{...r,label:o,to:s})},docsVersionDropdown:function(e){let{mobile:t,docsPluginId:n,dropdownActiveClassDisabled:a,dropdownItemsBefore:r,dropdownItemsAfter:i,...o}=e;const{search:c,hash:d}=(0,s.zy)(),p=(0,fi.zK)(n),m=(0,fi.jh)(n),{savePreferredVersionName:f}=(0,bi.g1)(n),h=m.map((e=>{const t=p.alternateDocVersions[e.name]??yi(e);return{label:e.label,to:`${t.path}${c}${d}`,isActive:()=>e===p.activeVersion,onClick:()=>f(e.name)}})),b=[...r,...h,...i],y=(0,hi.Vd)(n)[0],g=t&&b.length>1?(0,l.T)({id:"theme.navbar.mobileVersionsDropdown.label",message:"Versions",description:"The label for the navbar versions dropdown on mobile view"}):y.label,v=t&&b.length>1?void 0:yi(y).path;return b.length<=1?(0,u.jsx)(ie,{...o,mobile:t,label:g,to:v,isActive:a?()=>!1:void 0}):(0,u.jsx)(me,{...o,mobile:t,label:g,to:v,items:b,isActive:a?()=>!1:void 0})}},vi=gi;function xi(e){let{type:t,...n}=e;const a=function(e,t){return e&&"default"!==e?e:"items"in t?"dropdown":"default"}(t,n),r=vi[a];if(!r)throw new Error(`No NavbarItem component found for type "${t}".`);return(0,u.jsx)(r,{...n})}function wi(){const e=(0,P.M)(),t=(0,x.p)().navbar.items;return(0,u.jsx)("ul",{className:"menu__list",children:t.map(((t,n)=>(0,a.createElement)(xi,{mobile:!0,...t,onClick:()=>e.toggle(),key:n})))})}function Si(e){return(0,u.jsx)("button",{...e,type:"button",className:"clean-btn navbar-sidebar__back",children:(0,u.jsx)(l.A,{id:"theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel",description:"The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)",children:"\u2190 Back to main menu"})})}function _i(){const e=0===(0,x.p)().navbar.items.length,t=D();return(0,u.jsxs)(u.Fragment,{children:[!e&&(0,u.jsx)(Si,{onClick:()=>t.hide()}),t.content]})}function ki(){const e=(0,P.M)();var t;return void 0===(t=e.shown)&&(t=!0),(0,a.useEffect)((()=>(document.body.style.overflow=t?"hidden":"visible",()=>{document.body.style.overflow="visible"})),[t]),e.shouldRender?(0,u.jsx)(q,{header:(0,u.jsx)(Y,{}),primaryMenu:(0,u.jsx)(wi,{}),secondaryMenu:(0,u.jsx)(_i,{})}):null}const ji={navbarHideable:"navbarHideable_m1mJ",navbarHidden:"navbarHidden_jGov"};function Ei(e){return(0,u.jsx)("div",{role:"presentation",...e,className:(0,r.A)("navbar-sidebar__backdrop",e.className)})}function Oi(e){let{children:t}=e;const{navbar:{hideOnScroll:n,style:i}}=(0,x.p)(),o=(0,P.M)(),{navbarRef:s,isNavbarVisible:d}=function(e){const[t,n]=(0,a.useState)(e),r=(0,a.useRef)(!1),i=(0,a.useRef)(0),o=(0,a.useCallback)((e=>{null!==e&&(i.current=e.getBoundingClientRect().height)}),[]);return(0,A.Mq)(((t,a)=>{let{scrollY:o}=t;if(!e)return;if(o=s?n(!1):o+c{if(!e)return;const a=t.location.hash;if(a?document.getElementById(a.substring(1)):void 0)return r.current=!0,void n(!1);n(!0)})),{navbarRef:o,isNavbarVisible:t}}(n);return(0,u.jsxs)("nav",{ref:s,"aria-label":(0,l.T)({id:"theme.NavBar.navAriaLabel",message:"Main",description:"The ARIA label for the main navigation"}),className:(0,r.A)("navbar","navbar--fixed-top",n&&[ji.navbarHideable,!d&&ji.navbarHidden],{"navbar--dark":"dark"===i,"navbar--primary":"primary"===i,"navbar-sidebar--show":o.shown}),children:[t,(0,u.jsx)(Ei,{onClick:o.toggle}),(0,u.jsx)(ki,{})]})}var Ci=n(64609);const Pi={errorBoundaryError:"errorBoundaryError_a6uf",errorBoundaryFallback:"errorBoundaryFallback_VBag"};function Ai(e){return(0,u.jsx)("button",{type:"button",...e,children:(0,u.jsx)(l.A,{id:"theme.ErrorPageContent.tryAgain",description:"The label of the button to try again rendering when the React error boundary captures an error",children:"Try again"})})}function Ti(e){let{error:t}=e;const n=(0,Ci.getErrorCausalChain)(t).map((e=>e.message)).join("\n\nCause:\n");return(0,u.jsx)("p",{className:Pi.errorBoundaryError,children:n})}class Ii extends a.Component{componentDidCatch(e,t){throw this.props.onError(e,t)}render(){return this.props.children}}const Ni="right";function Ri(e){let{width:t=30,height:n=30,className:a,...r}=e;return(0,u.jsx)("svg",{className:a,width:t,height:n,viewBox:"0 0 30 30","aria-hidden":"true",...r,children:(0,u.jsx)("path",{stroke:"currentColor",strokeLinecap:"round",strokeMiterlimit:"10",strokeWidth:"2",d:"M4 7h22M4 15h22M4 23h22"})})}function Li(){const{toggle:e,shown:t}=(0,P.M)();return(0,u.jsx)("button",{onClick:e,"aria-label":(0,l.T)({id:"theme.docs.sidebar.toggleSidebarButtonAriaLabel",message:"Toggle navigation bar",description:"The ARIA label for hamburger menu button of mobile navigation"}),"aria-expanded":t,className:"navbar__toggle clean-btn",type:"button",children:(0,u.jsx)(Ri,{})})}const Di={colorModeToggle:"colorModeToggle_DEke"};function qi(e){let{items:t}=e;return(0,u.jsx)(u.Fragment,{children:t.map(((e,t)=>(0,u.jsx)(Ii,{onError:t=>new Error(`A theme navbar item failed to render.\nPlease double-check the following navbar item (themeConfig.navbar.items) of your Docusaurus config:\n${JSON.stringify(e,null,2)}`,{cause:t}),children:(0,u.jsx)(xi,{...e})},t)))})}function Fi(e){let{left:t,right:n}=e;return(0,u.jsxs)("div",{className:"navbar__inner",children:[(0,u.jsx)("div",{className:"navbar__items",children:t}),(0,u.jsx)("div",{className:"navbar__items navbar__items--right",children:n})]})}function Mi(){const e=(0,P.M)(),t=(0,x.p)().navbar.items,[n,a]=function(e){function t(e){return"left"===(e.position??Ni)}return[e.filter(t),e.filter((e=>!t(e)))]}(t),r=t.find((e=>"search"===e.type));return(0,u.jsx)(Fi,{left:(0,u.jsxs)(u.Fragment,{children:[!e.disabled&&(0,u.jsx)(Li,{}),(0,u.jsx)(W,{}),(0,u.jsx)(qi,{items:n})]}),right:(0,u.jsxs)(u.Fragment,{children:[(0,u.jsx)(qi,{items:a}),(0,u.jsx)(G,{className:Di.colorModeToggle}),!r&&(0,u.jsx)(mi,{children:(0,u.jsx)(di,{})})]})})}function Bi(){return(0,u.jsx)(Oi,{children:(0,u.jsx)(Mi,{})})}function zi(e){let{item:t}=e;const{to:n,href:a,label:r,prependBaseUrlToHref:i,...o}=t,s=(0,Z.A)(n),l=(0,Z.A)(a,{forcePrependBaseUrl:!0});return(0,u.jsxs)(J.A,{className:"footer__link-item",...a?{href:i?l:a}:{to:s},...o,children:[r,a&&!(0,X.A)(a)&&(0,u.jsx)(te.A,{})]})}function Ui(e){let{item:t}=e;return t.html?(0,u.jsx)("li",{className:"footer__item",dangerouslySetInnerHTML:{__html:t.html}}):(0,u.jsx)("li",{className:"footer__item",children:(0,u.jsx)(zi,{item:t})},t.href??t.to)}function $i(e){let{column:t}=e;return(0,u.jsxs)("div",{className:"col footer__col",children:[(0,u.jsx)("div",{className:"footer__title",children:t.title}),(0,u.jsx)("ul",{className:"footer__items clean-list",children:t.items.map(((e,t)=>(0,u.jsx)(Ui,{item:e},t)))})]})}function Qi(e){let{columns:t}=e;return(0,u.jsx)("div",{className:"row footer__links",children:t.map(((e,t)=>(0,u.jsx)($i,{column:e},t)))})}function Hi(){return(0,u.jsx)("span",{className:"footer__link-separator",children:"\xb7"})}function Gi(e){let{item:t}=e;return t.html?(0,u.jsx)("span",{className:"footer__link-item",dangerouslySetInnerHTML:{__html:t.html}}):(0,u.jsx)(zi,{item:t})}function Vi(e){let{links:t}=e;return(0,u.jsx)("div",{className:"footer__links text--center",children:(0,u.jsx)("div",{className:"footer__links",children:t.map(((e,n)=>(0,u.jsxs)(a.Fragment,{children:[(0,u.jsx)(Gi,{item:e}),t.length!==n+1&&(0,u.jsx)(Hi,{})]},n)))})})}function Wi(e){let{links:t}=e;return function(e){return"title"in e[0]}(t)?(0,u.jsx)(Qi,{columns:t}):(0,u.jsx)(Vi,{links:t})}var Ki=n(40975);const Yi={footerLogoLink:"footerLogoLink_BH7S"};function Ji(e){let{logo:t}=e;const{withBaseUrl:n}=(0,Z.h)(),a={light:n(t.src),dark:n(t.srcDark??t.src)};return(0,u.jsx)(Ki.A,{className:(0,r.A)("footer__logo",t.className),alt:t.alt,sources:a,width:t.width,height:t.height,style:t.style})}function Zi(e){let{logo:t}=e;return t.href?(0,u.jsx)(J.A,{href:t.href,className:Yi.footerLogoLink,target:t.target,children:(0,u.jsx)(Ji,{logo:t})}):(0,u.jsx)(Ji,{logo:t})}function Xi(e){let{copyright:t}=e;return(0,u.jsx)("div",{className:"footer__copyright",dangerouslySetInnerHTML:{__html:t}})}function eo(e){let{style:t,links:n,logo:a,copyright:i}=e;return(0,u.jsx)("footer",{className:(0,r.A)("footer",{"footer--dark":"dark"===t}),children:(0,u.jsxs)("div",{className:"container container-fluid",children:[n,(a||i)&&(0,u.jsxs)("div",{className:"footer__bottom text--center",children:[a&&(0,u.jsx)("div",{className:"margin-bottom--sm",children:a}),i]})]})})}function to(){const{footer:e}=(0,x.p)();if(!e)return null;const{copyright:t,links:n,logo:a,style:r}=e;return(0,u.jsx)(eo,{style:r,links:n&&n.length>0&&(0,u.jsx)(Wi,{links:n}),logo:a&&(0,u.jsx)(Zi,{logo:a}),copyright:t&&(0,u.jsx)(Xi,{copyright:t})})}const no=a.memo(to),ao=(0,T.fM)([F.a,w.oq,A.Tv,bi.VQ,o.Jx,function(e){let{children:t}=e;return(0,u.jsx)(I.y_,{children:(0,u.jsx)(P.e,{children:(0,u.jsx)(R,{children:t})})})}]);function ro(e){let{children:t}=e;return(0,u.jsx)(ao,{children:t})}var io=n(85225);function oo(e){let{error:t,tryAgain:n}=e;return(0,u.jsx)("main",{className:"container margin-vert--xl",children:(0,u.jsx)("div",{className:"row",children:(0,u.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,u.jsx)(io.A,{as:"h1",className:"hero__title",children:(0,u.jsx)(l.A,{id:"theme.ErrorPageContent.title",description:"The title of the fallback page when the page crashed",children:"This page crashed."})}),(0,u.jsx)("div",{className:"margin-vert--lg",children:(0,u.jsx)(Ai,{onClick:n,className:"button button--primary shadow--lw"})}),(0,u.jsx)("hr",{}),(0,u.jsx)("div",{className:"margin-vert--md",children:(0,u.jsx)(Ti,{error:t})})]})})})}const so={mainWrapper:"mainWrapper_z2l0"};function lo(e){const{children:t,noFooter:n,wrapperClassName:a,title:s,description:l}=e;return(0,y.J)(),(0,u.jsxs)(ro,{children:[(0,u.jsx)(o.be,{title:s,description:l}),(0,u.jsx)(v,{}),(0,u.jsx)(C,{}),(0,u.jsx)(Bi,{}),(0,u.jsx)("div",{id:d,className:(0,r.A)(b.G.wrapper.main,so.mainWrapper,a),children:(0,u.jsx)(i.A,{fallback:e=>(0,u.jsx)(oo,{...e}),children:t})}),!n&&(0,u.jsx)(no,{})]})}},20020:(e,t,n)=>{"use strict";n.d(t,{A:()=>u});n(96540);var a=n(14783),r=n(98180),i=n(97639),o=n(86957),s=n(40975),l=n(74848);function c(e){let{logo:t,alt:n,imageClassName:a}=e;const i={light:(0,r.A)(t.src),dark:(0,r.A)(t.srcDark||t.src)},o=(0,l.jsx)(s.A,{className:t.className,sources:i,height:t.height,width:t.width,alt:n,style:t.style});return a?(0,l.jsx)("div",{className:a,children:o}):o}function u(e){const{siteConfig:{title:t}}=(0,i.A)(),{navbar:{title:n,logo:s}}=(0,o.p)(),{imageClassName:u,titleClassName:d,...p}=e,m=(0,r.A)(s?.href||"/"),f=n?"":t,h=s?.alt??f;return(0,l.jsxs)(a.A,{to:m,...p,...s?.target&&{target:s.target},children:[s&&(0,l.jsx)(c,{logo:s,alt:h,imageClassName:u}),null!=n&&(0,l.jsx)("b",{className:d,children:n})]})}},51210:(e,t,n)=>{"use strict";n.d(t,{A:()=>i});n(96540);var a=n(21141),r=n(74848);function i(e){let{locale:t,version:n,tag:i}=e;const o=t;return(0,r.jsxs)(a.A,{children:[t&&(0,r.jsx)("meta",{name:"docusaurus_locale",content:t}),n&&(0,r.jsx)("meta",{name:"docusaurus_version",content:n}),i&&(0,r.jsx)("meta",{name:"docusaurus_tag",content:i}),o&&(0,r.jsx)("meta",{name:"docsearch:language",content:o}),n&&(0,r.jsx)("meta",{name:"docsearch:version",content:n}),i&&(0,r.jsx)("meta",{name:"docsearch:docusaurus_tag",content:i})]})}},40975:(e,t,n)=>{"use strict";n.d(t,{A:()=>u});var a=n(96540),r=n(15066),i=n(11062),o=n(7710);const s={themedComponent:"themedComponent_mlkZ","themedComponent--light":"themedComponent--light_NVdE","themedComponent--dark":"themedComponent--dark_xIcU"};var l=n(74848);function c(e){let{className:t,children:n}=e;const c=(0,i.A)(),{colorMode:u}=(0,o.G)();return(0,l.jsx)(l.Fragment,{children:(c?"dark"===u?["dark"]:["light"]:["light","dark"]).map((e=>{const i=n({theme:e,className:(0,r.A)(t,s.themedComponent,s[`themedComponent--${e}`])});return(0,l.jsx)(a.Fragment,{children:i},e)}))})}function u(e){const{sources:t,className:n,alt:a,...r}=e;return(0,l.jsx)(c,{className:n,children:e=>{let{theme:n,className:i}=e;return(0,l.jsx)("img",{src:t[n],alt:a,className:i,...r})}})}},94549:(e,t,n)=>{"use strict";n.d(t,{N:()=>y,u:()=>c});var a=n(96540),r=n(31712),i=n(36494),o=n(36350),s=n(74848);const l="ease-in-out";function c(e){let{initialState:t}=e;const[n,r]=(0,a.useState)(t??!1),i=(0,a.useCallback)((()=>{r((e=>!e))}),[]);return{collapsed:n,setCollapsed:r,toggleCollapsed:i}}const u={display:"none",overflow:"hidden",height:"0px"},d={display:"block",overflow:"visible",height:"auto"};function p(e,t){const n=t?u:d;e.style.display=n.display,e.style.overflow=n.overflow,e.style.height=n.height}function m(e){let{collapsibleRef:t,collapsed:n,animation:r}=e;const i=(0,a.useRef)(!1);(0,a.useEffect)((()=>{const e=t.current;function a(){const t=e.scrollHeight,n=r?.duration??function(e){if((0,o.O)())return 1;const t=e/36;return Math.round(10*(4+15*t**.25+t/5))}(t);return{transition:`height ${n}ms ${r?.easing??l}`,height:`${t}px`}}function s(){const t=a();e.style.transition=t.transition,e.style.height=t.height}if(!i.current)return p(e,n),void(i.current=!0);return e.style.willChange="height",function(){const t=requestAnimationFrame((()=>{n?(s(),requestAnimationFrame((()=>{e.style.height=u.height,e.style.overflow=u.overflow}))):(e.style.display="block",requestAnimationFrame((()=>{s()})))}));return()=>cancelAnimationFrame(t)}()}),[t,n,r])}function f(e){if(!r.A.canUseDOM)return e?u:d}function h(e){let{as:t="div",collapsed:n,children:r,animation:i,onCollapseTransitionEnd:o,className:l,disableSSRStyle:c}=e;const u=(0,a.useRef)(null);return m({collapsibleRef:u,collapsed:n,animation:i}),(0,s.jsx)(t,{ref:u,style:c?void 0:f(n),onTransitionEnd:e=>{"height"===e.propertyName&&(p(u.current,n),o?.(n))},className:l,children:r})}function b(e){let{collapsed:t,...n}=e;const[r,o]=(0,a.useState)(!t),[l,c]=(0,a.useState)(t);return(0,i.A)((()=>{t||o(!0)}),[t]),(0,i.A)((()=>{r&&c(t)}),[r,t]),r?(0,s.jsx)(h,{...n,collapsed:l}):null}function y(e){let{lazy:t,...n}=e;const a=t?b:h;return(0,s.jsx)(a,{...n})}},40002:(e,t,n)=>{"use strict";n.d(t,{Mj:()=>h,oq:()=>f});var a=n(96540),r=n(11062),i=n(81269),o=n(4799),s=n(86957),l=n(74848);const c=(0,i.Wf)("docusaurus.announcement.dismiss"),u=(0,i.Wf)("docusaurus.announcement.id"),d=()=>"true"===c.get(),p=e=>c.set(String(e)),m=a.createContext(null);function f(e){let{children:t}=e;const n=function(){const{announcementBar:e}=(0,s.p)(),t=(0,r.A)(),[n,i]=(0,a.useState)((()=>!!t&&d()));(0,a.useEffect)((()=>{i(d())}),[]);const o=(0,a.useCallback)((()=>{p(!0),i(!0)}),[]);return(0,a.useEffect)((()=>{if(!e)return;const{id:t}=e;let n=u.get();"annoucement-bar"===n&&(n="announcement-bar");const a=t!==n;u.set(t),a&&p(!1),!a&&d()||i(!1)}),[e]),(0,a.useMemo)((()=>({isActive:!!e&&!n,close:o})),[e,n,o])}();return(0,l.jsx)(m.Provider,{value:n,children:t})}function h(){const e=(0,a.useContext)(m);if(!e)throw new o.dV("AnnouncementBarProvider");return e}},7710:(e,t,n)=>{"use strict";n.d(t,{G:()=>y,a:()=>b});var a=n(96540),r=n(31712),i=n(4799),o=n(81269),s=n(86957),l=n(74848);const c=a.createContext(void 0),u="theme",d=(0,o.Wf)(u),p={light:"light",dark:"dark"},m=e=>e===p.dark?p.dark:p.light,f=e=>r.A.canUseDOM?m(document.documentElement.getAttribute("data-theme")):m(e),h=e=>{d.set(m(e))};function b(e){let{children:t}=e;const n=function(){const{colorMode:{defaultMode:e,disableSwitch:t,respectPrefersColorScheme:n}}=(0,s.p)(),[r,i]=(0,a.useState)(f(e));(0,a.useEffect)((()=>{t&&d.del()}),[t]);const o=(0,a.useCallback)((function(t,a){void 0===a&&(a={});const{persist:r=!0}=a;t?(i(t),r&&h(t)):(i(n?window.matchMedia("(prefers-color-scheme: dark)").matches?p.dark:p.light:e),d.del())}),[n,e]);(0,a.useEffect)((()=>{document.documentElement.setAttribute("data-theme",m(r))}),[r]),(0,a.useEffect)((()=>{if(t)return;const e=e=>{if(e.key!==u)return;const t=d.get();null!==t&&o(m(t))};return window.addEventListener("storage",e),()=>window.removeEventListener("storage",e)}),[t,o]);const l=(0,a.useRef)(!1);return(0,a.useEffect)((()=>{if(t&&!n)return;const e=window.matchMedia("(prefers-color-scheme: dark)"),a=()=>{window.matchMedia("print").matches||l.current?l.current=window.matchMedia("print").matches:o(null)};return e.addListener(a),()=>e.removeListener(a)}),[o,t,n]),(0,a.useMemo)((()=>({colorMode:r,setColorMode:o,get isDarkTheme(){return r===p.dark},setLightTheme(){o(p.light)},setDarkTheme(){o(p.dark)}})),[r,o])}();return(0,l.jsx)(c.Provider,{value:n,children:t})}function y(){const e=(0,a.useContext)(c);if(null==e)throw new i.dV("ColorModeProvider","Please see https://docusaurus.io/docs/api/themes/configuration#use-color-mode.");return e}},2780:(e,t,n)=>{"use strict";n.d(t,{VQ:()=>y,XK:()=>x,g1:()=>v});var a=n(96540),r=n(19802),i=n(44598),o=n(86957),s=n(5215),l=n(4799),c=n(81269),u=n(74848);const d=e=>`docs-preferred-version-${e}`,p={save:(e,t,n)=>{(0,c.Wf)(d(e),{persistence:t}).set(n)},read:(e,t)=>(0,c.Wf)(d(e),{persistence:t}).get(),clear:(e,t)=>{(0,c.Wf)(d(e),{persistence:t}).del()}},m=e=>Object.fromEntries(e.map((e=>[e,{preferredVersionName:null}])));const f=a.createContext(null);function h(){const e=(0,r.Gy)(),t=(0,o.p)().docs.versionPersistence,n=(0,a.useMemo)((()=>Object.keys(e)),[e]),[i,s]=(0,a.useState)((()=>m(n)));(0,a.useEffect)((()=>{s(function(e){let{pluginIds:t,versionPersistence:n,allDocsData:a}=e;function r(e){const t=p.read(e,n);return a[e].versions.some((e=>e.name===t))?{preferredVersionName:t}:(p.clear(e,n),{preferredVersionName:null})}return Object.fromEntries(t.map((e=>[e,r(e)])))}({allDocsData:e,versionPersistence:t,pluginIds:n}))}),[e,t,n]);return[i,(0,a.useMemo)((()=>({savePreferredVersion:function(e,n){p.save(e,t,n),s((t=>({...t,[e]:{preferredVersionName:n}})))}})),[t])]}function b(e){let{children:t}=e;const n=h();return(0,u.jsx)(f.Provider,{value:n,children:t})}function y(e){let{children:t}=e;return s.C5?(0,u.jsx)(b,{children:t}):(0,u.jsx)(u.Fragment,{children:t})}function g(){const e=(0,a.useContext)(f);if(!e)throw new l.dV("DocsPreferredVersionContextProvider");return e}function v(e){void 0===e&&(e=i.W);const t=(0,r.ht)(e),[n,o]=g(),{preferredVersionName:s}=n[e];return{preferredVersion:t.versions.find((e=>e.name===s))??null,savePreferredVersionName:(0,a.useCallback)((t=>{o.savePreferredVersion(e,t)}),[o,e])}}function x(){const e=(0,r.Gy)(),[t]=g();function n(n){const a=e[n],{preferredVersionName:r}=t[n];return a.versions.find((e=>e.name===r))??null}const a=Object.keys(e);return Object.fromEntries(a.map((e=>[e,n(e)])))}},403:(e,t,n)=>{"use strict";n.d(t,{V:()=>l,t:()=>c});var a=n(96540),r=n(4799),i=n(74848);const o=Symbol("EmptyContext"),s=a.createContext(o);function l(e){let{children:t,name:n,items:r}=e;const o=(0,a.useMemo)((()=>n&&r?{name:n,items:r}:null),[n,r]);return(0,i.jsx)(s.Provider,{value:o,children:t})}function c(){const e=(0,a.useContext)(s);if(e===o)throw new r.dV("DocsSidebarProvider");return e}},33403:(e,t,n)=>{"use strict";n.d(t,{n:()=>s,r:()=>l});var a=n(96540),r=n(4799),i=n(74848);const o=a.createContext(null);function s(e){let{children:t,version:n}=e;return(0,i.jsx)(o.Provider,{value:n,children:t})}function l(){const e=(0,a.useContext)(o);if(null===e)throw new r.dV("DocsVersionProvider");return e}},61938:(e,t,n)=>{"use strict";n.d(t,{M:()=>m,e:()=>p});var a=n(96540),r=n(70763),i=n(82216),o=n(62814),s=n(86957),l=n(4799),c=n(74848);const u=a.createContext(void 0);function d(){const e=function(){const e=(0,r.YL)(),{items:t}=(0,s.p)().navbar;return 0===t.length&&!e.component}(),t=(0,i.l)(),n=!e&&"mobile"===t,[l,c]=(0,a.useState)(!1);(0,o.$Z)((()=>{if(l)return c(!1),!1}));const u=(0,a.useCallback)((()=>{c((e=>!e))}),[]);return(0,a.useEffect)((()=>{"desktop"===t&&c(!1)}),[t]),(0,a.useMemo)((()=>({disabled:e,shouldRender:n,toggle:u,shown:l})),[e,n,u,l])}function p(e){let{children:t}=e;const n=d();return(0,c.jsx)(u.Provider,{value:n,children:t})}function m(){const e=a.useContext(u);if(void 0===e)throw new l.dV("NavbarMobileSidebarProvider");return e}},70763:(e,t,n)=>{"use strict";n.d(t,{GX:()=>c,YL:()=>l,y_:()=>s});var a=n(96540),r=n(4799),i=n(74848);const o=a.createContext(null);function s(e){let{children:t}=e;const n=(0,a.useState)({component:null,props:null});return(0,i.jsx)(o.Provider,{value:n,children:t})}function l(){const e=(0,a.useContext)(o);if(!e)throw new r.dV("NavbarSecondaryMenuContentProvider");return e[0]}function c(e){let{component:t,props:n}=e;const i=(0,a.useContext)(o);if(!i)throw new r.dV("NavbarSecondaryMenuContentProvider");const[,s]=i,l=(0,r.Be)(n);return(0,a.useEffect)((()=>{s({component:t,props:l})}),[s,t,l]),(0,a.useEffect)((()=>()=>s({component:null,props:null})),[s]),null}},19503:(e,t,n)=>{"use strict";n.d(t,{w:()=>r,J:()=>i});var a=n(96540);const r="navigation-with-keyboard";function i(){(0,a.useEffect)((()=>{function e(e){"keydown"===e.type&&"Tab"===e.key&&document.body.classList.add(r),"mousedown"===e.type&&document.body.classList.remove(r)}return document.addEventListener("keydown",e),document.addEventListener("mousedown",e),()=>{document.body.classList.remove(r),document.removeEventListener("keydown",e),document.removeEventListener("mousedown",e)}}),[])}},82216:(e,t,n)=>{"use strict";n.d(t,{l:()=>s});var a=n(96540),r=n(31712);const i={desktop:"desktop",mobile:"mobile",ssr:"ssr"},o=996;function s(e){let{desktopBreakpoint:t=o}=void 0===e?{}:e;const[n,s]=(0,a.useState)((()=>"ssr"));return(0,a.useEffect)((()=>{function e(){s(function(e){if(!r.A.canUseDOM)throw new Error("getWindowSize() should only be called after React hydration");return window.innerWidth>e?i.desktop:i.mobile}(t))}return e(),window.addEventListener("resize",e),()=>{window.removeEventListener("resize",e)}}),[t]),n}},18630:(e,t,n)=>{"use strict";n.d(t,{G:()=>a});const a={page:{blogListPage:"blog-list-page",blogPostPage:"blog-post-page",blogTagsListPage:"blog-tags-list-page",blogTagPostListPage:"blog-tags-post-list-page",docsDocPage:"docs-doc-page",docsTagsListPage:"docs-tags-list-page",docsTagDocListPage:"docs-tags-doc-list-page",mdxPage:"mdx-page"},wrapper:{main:"main-wrapper",blogPages:"blog-wrapper",docsPages:"docs-wrapper",mdxPages:"mdx-wrapper"},common:{editThisPage:"theme-edit-this-page",lastUpdated:"theme-last-updated",backToTopButton:"theme-back-to-top-button",codeBlock:"theme-code-block",admonition:"theme-admonition",unlistedBanner:"theme-unlisted-banner",admonitionType:e=>`theme-admonition-${e}`},layout:{},docs:{docVersionBanner:"theme-doc-version-banner",docVersionBadge:"theme-doc-version-badge",docBreadcrumbs:"theme-doc-breadcrumbs",docMarkdown:"theme-doc-markdown",docTocMobile:"theme-doc-toc-mobile",docTocDesktop:"theme-doc-toc-desktop",docFooter:"theme-doc-footer",docFooterTagsRow:"theme-doc-footer-tags-row",docFooterEditMetaRow:"theme-doc-footer-edit-meta-row",docSidebarContainer:"theme-doc-sidebar-container",docSidebarMenu:"theme-doc-sidebar-menu",docSidebarItemCategory:"theme-doc-sidebar-item-category",docSidebarItemLink:"theme-doc-sidebar-item-link",docSidebarItemCategoryLevel:e=>`theme-doc-sidebar-item-category-level-${e}`,docSidebarItemLinkLevel:e=>`theme-doc-sidebar-item-link-level-${e}`},blog:{}}},36350:(e,t,n)=>{"use strict";function a(){return window.matchMedia("(prefers-reduced-motion: reduce)").matches}n.d(t,{O:()=>a})},5215:(e,t,n)=>{"use strict";n.d(t,{$S:()=>h,B5:()=>E,C5:()=>p,Nr:()=>f,OF:()=>S,QB:()=>j,Vd:()=>_,Y:()=>x,cC:()=>m,d1:()=>O,fW:()=>k,w8:()=>g});var a=n(96540),r=n(56347),i=n(22831),o=n(19802),s=n(2780),l=n(33403),c=n(403),u=n(45167),d=n(80260);const p=!!o.Gy;function m(e){const t=(0,l.r)();if(!e)return;const n=t.docs[e];if(!n)throw new Error(`no version doc found by id=${e}`);return n}function f(e){return"link"!==e.type||e.unlisted?"category"===e.type?function(e){if(e.href&&!e.linkUnlisted)return e.href;for(const t of e.items){const e=f(t);if(e)return e}}(e):void 0:e.href}function h(){const{pathname:e}=(0,r.zy)(),t=(0,c.t)();if(!t)throw new Error("Unexpected: cant find current sidebar in context");const n=w({sidebarItems:t.items,pathname:e,onlyCategories:!0}).slice(-1)[0];if(!n)throw new Error(`${e} is not associated with a category. useCurrentSidebarCategory() should only be used on category index pages.`);return n}const b=(e,t)=>void 0!==e&&(0,d.ys)(e,t),y=(e,t)=>e.some((e=>g(e,t)));function g(e,t){return"link"===e.type?b(e.href,t):"category"===e.type&&(b(e.href,t)||y(e.items,t))}function v(e,t){switch(e.type){case"category":return g(e,t)||e.items.some((e=>v(e,t)));case"link":return!e.unlisted||g(e,t);default:return!0}}function x(e,t){return(0,a.useMemo)((()=>e.filter((e=>v(e,t)))),[e,t])}function w(e){let{sidebarItems:t,pathname:n,onlyCategories:a=!1}=e;const r=[];return function e(t){for(const i of t)if("category"===i.type&&((0,d.ys)(i.href,n)||e(i.items))||"link"===i.type&&(0,d.ys)(i.href,n)){return a&&"category"!==i.type||r.unshift(i),!0}return!1}(t),r}function S(){const e=(0,c.t)(),{pathname:t}=(0,r.zy)(),n=(0,o.vT)()?.pluginData.breadcrumbs;return!1!==n&&e?w({sidebarItems:e.items,pathname:t}):null}function _(e){const{activeVersion:t}=(0,o.zK)(e),{preferredVersion:n}=(0,s.g1)(e),r=(0,o.r7)(e);return(0,a.useMemo)((()=>(0,u.s)([t,n,r].filter(Boolean))),[t,n,r])}function k(e,t){const n=_(t);return(0,a.useMemo)((()=>{const t=n.flatMap((e=>e.sidebars?Object.entries(e.sidebars):[])),a=t.find((t=>t[0]===e));if(!a)throw new Error(`Can't find any sidebar with id "${e}" in version${n.length>1?"s":""} ${n.map((e=>e.name)).join(", ")}".\nAvailable sidebar ids are:\n- ${t.map((e=>e[0])).join("\n- ")}`);return a[1]}),[e,n])}function j(e,t){const n=_(t);return(0,a.useMemo)((()=>{const t=n.flatMap((e=>e.docs)),a=t.find((t=>t.id===e));if(!a){if(n.flatMap((e=>e.draftIds)).includes(e))return null;throw new Error(`Couldn't find any doc with id "${e}" in version${n.length>1?"s":""} "${n.map((e=>e.name)).join(", ")}".\nAvailable doc ids are:\n- ${(0,u.s)(t.map((e=>e.id))).join("\n- ")}`)}return a}),[e,n])}function E(e){let{route:t}=e;const n=(0,r.zy)(),a=(0,l.r)(),o=t.routes,s=o.find((e=>(0,r.B6)(n.pathname,e)));if(!s)return null;const c=s.sidebar,u=c?a.docsSidebars[c]:void 0;return{docElement:(0,i.v)(o),sidebarName:c,sidebarItems:u}}function O(e){return e.filter((e=>!("category"===e.type||"link"===e.type)||!!f(e)))}},62814:(e,t,n)=>{"use strict";n.d(t,{$Z:()=>o,aZ:()=>s});var a=n(96540),r=n(56347),i=n(4799);function o(e){!function(e){const t=(0,r.W6)(),n=(0,i._q)(e);(0,a.useEffect)((()=>t.block(((e,t)=>n(e,t)))),[t,n])}(((t,n)=>{if("POP"===n)return e(t,n)}))}function s(e){return function(e){const t=(0,r.W6)();return(0,a.useSyncExternalStore)(t.listen,(()=>e(t)),(()=>e(t)))}((t=>null===e?null:new URLSearchParams(t.location.search).get(e)))}},45167:(e,t,n)=>{"use strict";function a(e,t){return void 0===t&&(t=(e,t)=>e===t),e.filter(((n,a)=>e.findIndex((e=>t(e,n)))!==a))}function r(e){return Array.from(new Set(e))}n.d(t,{X:()=>a,s:()=>r})},69817:(e,t,n)=>{"use strict";n.d(t,{e3:()=>m,be:()=>d,Jx:()=>f});var a=n(96540),r=n(15066),i=n(21141),o=n(23363);function s(){const e=a.useContext(o.o);if(!e)throw new Error("Unexpected: no Docusaurus route context found");return e}var l=n(98180),c=n(97639);var u=n(74848);function d(e){let{title:t,description:n,keywords:a,image:r,children:o}=e;const s=function(e){const{siteConfig:t}=(0,c.A)(),{title:n,titleDelimiter:a}=t;return e?.trim().length?`${e.trim()} ${a} ${n}`:n}(t),{withBaseUrl:d}=(0,l.h)(),p=r?d(r,{absolute:!0}):void 0;return(0,u.jsxs)(i.A,{children:[t&&(0,u.jsx)("title",{children:s}),t&&(0,u.jsx)("meta",{property:"og:title",content:s}),n&&(0,u.jsx)("meta",{name:"description",content:n}),n&&(0,u.jsx)("meta",{property:"og:description",content:n}),a&&(0,u.jsx)("meta",{name:"keywords",content:Array.isArray(a)?a.join(","):a}),p&&(0,u.jsx)("meta",{property:"og:image",content:p}),p&&(0,u.jsx)("meta",{name:"twitter:image",content:p}),o]})}const p=a.createContext(void 0);function m(e){let{className:t,children:n}=e;const o=a.useContext(p),s=(0,r.A)(o,t);return(0,u.jsxs)(p.Provider,{value:s,children:[(0,u.jsx)(i.A,{children:(0,u.jsx)("html",{className:s})}),n]})}function f(e){let{children:t}=e;const n=s(),a=`plugin-${n.plugin.name.replace(/docusaurus-(?:plugin|theme)-(?:content-)?/gi,"")}`;const i=`plugin-id-${n.plugin.id}`;return(0,u.jsx)(m,{className:(0,r.A)(a,i),children:t})}},4799:(e,t,n)=>{"use strict";n.d(t,{Be:()=>c,ZC:()=>s,_q:()=>o,dV:()=>l,fM:()=>u});var a=n(96540),r=n(36494),i=n(74848);function o(e){const t=(0,a.useRef)(e);return(0,r.A)((()=>{t.current=e}),[e]),(0,a.useCallback)((function(){return t.current(...arguments)}),[])}function s(e){const t=(0,a.useRef)();return(0,r.A)((()=>{t.current=e})),t.current}class l extends Error{constructor(e,t){super(),this.name="ReactContextError",this.message=`Hook ${this.stack?.split("\n")[1]?.match(/at (?:\w+\.)?(?\w+)/)?.groups.name??""} is called outside the <${e}>. ${t??""}`}}function c(e){const t=Object.entries(e);return t.sort(((e,t)=>e[0].localeCompare(t[0]))),(0,a.useMemo)((()=>e),t.flat())}function u(e){return t=>{let{children:n}=t;return(0,i.jsx)(i.Fragment,{children:e.reduceRight(((e,t)=>(0,i.jsx)(t,{children:e})),n)})}}},80260:(e,t,n)=>{"use strict";n.d(t,{Dt:()=>s,ys:()=>o});var a=n(96540),r=n(92413),i=n(97639);function o(e,t){const n=e=>(!e||e.endsWith("/")?e:`${e}/`)?.toLowerCase();return n(e)===n(t)}function s(){const{baseUrl:e}=(0,i.A)().siteConfig;return(0,a.useMemo)((()=>function(e){let{baseUrl:t,routes:n}=e;function a(e){return e.path===t&&!0===e.exact}function r(e){return e.path===t&&!e.exact}return function e(t){if(0===t.length)return;return t.find(a)||e(t.filter(r).flatMap((e=>e.routes??[])))}(n)}({routes:r.A,baseUrl:e})),[e])}},24245:(e,t,n)=>{"use strict";n.d(t,{Mq:()=>m,Tv:()=>u,a_:()=>f,gk:()=>h});var a=n(96540),r=n(31712),i=n(11062),o=n(36494),s=n(4799),l=n(74848);const c=a.createContext(void 0);function u(e){let{children:t}=e;const n=function(){const e=(0,a.useRef)(!0);return(0,a.useMemo)((()=>({scrollEventsEnabledRef:e,enableScrollEvents:()=>{e.current=!0},disableScrollEvents:()=>{e.current=!1}})),[])}();return(0,l.jsx)(c.Provider,{value:n,children:t})}function d(){const e=(0,a.useContext)(c);if(null==e)throw new s.dV("ScrollControllerProvider");return e}const p=()=>r.A.canUseDOM?{scrollX:window.pageXOffset,scrollY:window.pageYOffset}:null;function m(e,t){void 0===t&&(t=[]);const{scrollEventsEnabledRef:n}=d(),r=(0,a.useRef)(p()),i=(0,s._q)(e);(0,a.useEffect)((()=>{const e=()=>{if(!n.current)return;const e=p();i(e,r.current),r.current=e},t={passive:!0};return e(),window.addEventListener("scroll",e,t),()=>window.removeEventListener("scroll",e,t)}),[i,n,...t])}function f(){const e=d(),t=function(){const e=(0,a.useRef)({elem:null,top:0}),t=(0,a.useCallback)((t=>{e.current={elem:t,top:t.getBoundingClientRect().top}}),[]),n=(0,a.useCallback)((()=>{const{current:{elem:t,top:n}}=e;if(!t)return{restored:!1};const a=t.getBoundingClientRect().top-n;return a&&window.scrollBy({left:0,top:a}),e.current={elem:null,top:0},{restored:0!==a}}),[]);return(0,a.useMemo)((()=>({save:t,restore:n})),[n,t])}(),n=(0,a.useRef)(void 0),r=(0,a.useCallback)((a=>{t.save(a),e.disableScrollEvents(),n.current=()=>{const{restored:a}=t.restore();if(n.current=void 0,a){const t=()=>{e.enableScrollEvents(),window.removeEventListener("scroll",t)};window.addEventListener("scroll",t)}else e.enableScrollEvents()}}),[e,t]);return(0,o.A)((()=>{queueMicrotask((()=>n.current?.()))})),{blockElementScrollPositionUntilNextRender:r}}function h(){const e=(0,a.useRef)(null),t=(0,i.A)()&&"smooth"===getComputedStyle(document.documentElement).scrollBehavior;return{startScroll:n=>{e.current=t?function(e){return window.scrollTo({top:e,behavior:"smooth"}),()=>{}}(n):function(e){let t=null;const n=document.documentElement.scrollTop>e;return function a(){const r=document.documentElement.scrollTop;(n&&r>e||!n&&rt&&cancelAnimationFrame(t)}(n)},cancelScroll:()=>e.current?.()}}},61482:(e,t,n)=>{"use strict";n.d(t,{Cy:()=>o,af:()=>l,tU:()=>s});var a=n(19802),r=n(97639),i=n(2780);const o="default";function s(e,t){return`docs-${e}-${t}`}function l(){const{i18n:e}=(0,r.A)(),t=(0,a.Gy)(),n=(0,a.gk)(),l=(0,i.XK)();const c=[o,...Object.keys(t).map((function(e){const a=n?.activePlugin.pluginId===e?n.activeVersion:void 0,r=l[e],i=t[e].versions.find((e=>e.isLast));return s(e,(a??r??i).name)}))];return{locale:e.currentLocale,tags:c}}},81269:(e,t,n)=>{"use strict";n.d(t,{Dv:()=>u,Wf:()=>c});var a=n(96540);const r="localStorage";function i(e){let{key:t,oldValue:n,newValue:a,storage:r}=e;if(n===a)return;const i=document.createEvent("StorageEvent");i.initStorageEvent("storage",!1,!1,t,n,a,window.location.href,r),window.dispatchEvent(i)}function o(e){if(void 0===e&&(e=r),"undefined"==typeof window)throw new Error("Browser storage is not available on Node.js/Docusaurus SSR process.");if("none"===e)return null;try{return window[e]}catch(n){return t=n,s||(console.warn("Docusaurus browser storage is not available.\nPossible reasons: running Docusaurus in an iframe, in an incognito browser session, or using too strict browser privacy settings.",t),s=!0),null}var t}let s=!1;const l={get:()=>null,set:()=>{},del:()=>{},listen:()=>()=>{}};function c(e,t){if("undefined"==typeof window)return function(e){function t(){throw new Error(`Illegal storage API usage for storage key "${e}".\nDocusaurus storage APIs are not supposed to be called on the server-rendering process.\nPlease only call storage APIs in effects and event handlers.`)}return{get:t,set:t,del:t,listen:t}}(e);const n=o(t?.persistence);return null===n?l:{get:()=>{try{return n.getItem(e)}catch(t){return console.error(`Docusaurus storage error, can't get key=${e}`,t),null}},set:t=>{try{const a=n.getItem(e);n.setItem(e,t),i({key:e,oldValue:a,newValue:t,storage:n})}catch(a){console.error(`Docusaurus storage error, can't set ${e}=${t}`,a)}},del:()=>{try{const t=n.getItem(e);n.removeItem(e),i({key:e,oldValue:t,newValue:null,storage:n})}catch(t){console.error(`Docusaurus storage error, can't delete key=${e}`,t)}},listen:t=>{try{const a=a=>{a.storageArea===n&&a.key===e&&t(a)};return window.addEventListener("storage",a),()=>window.removeEventListener("storage",a)}catch(a){return console.error(`Docusaurus storage error, can't listen for changes of key=${e}`,a),()=>{}}}}}function u(e,t){const n=(0,a.useRef)((()=>null===e?l:c(e,t))).current(),r=(0,a.useCallback)((e=>"undefined"==typeof window?()=>{}:n.listen(e)),[n]);return[(0,a.useSyncExternalStore)(r,(()=>"undefined"==typeof window?null:n.get()),(()=>null)),n]}},2098:(e,t,n)=>{"use strict";n.d(t,{o:()=>o});var a=n(97639),r=n(56347),i=n(64609);function o(){const{siteConfig:{baseUrl:e,url:t,trailingSlash:n},i18n:{defaultLocale:o,currentLocale:s}}=(0,a.A)(),{pathname:l}=(0,r.zy)(),c=(0,i.applyTrailingSlash)(l,{trailingSlash:n,baseUrl:e}),u=s===o?e:e.replace(`/${s}/`,"/"),d=c.replace(e,"");return{createUrl:function(e){let{locale:n,fullyQualified:a}=e;return`${a?t:""}${function(e){return e===o?`${u}`:`${u}${e}/`}(n)}${d}`}}}},54067:(e,t,n)=>{"use strict";n.d(t,{$:()=>o});var a=n(96540),r=n(56347),i=n(4799);function o(e){const t=(0,r.zy)(),n=(0,i.ZC)(t),o=(0,i._q)(e);(0,a.useEffect)((()=>{n&&t!==n&&o({location:t,previousLocation:n})}),[o,t,n])}},86957:(e,t,n)=>{"use strict";n.d(t,{p:()=>r});var a=n(97639);function r(){return(0,a.A)().siteConfig.themeConfig}},44356:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.default=function(e,t){const{trailingSlash:n,baseUrl:a}=t;if(e.startsWith("#"))return e;if(void 0===n)return e;const[r]=e.split(/[#?]/),i="/"===r||r===a?r:(o=r,n?function(e){return e.endsWith("/")?e:`${e}/`}(o):function(e){return e.endsWith("/")?e.slice(0,-1):e}(o));var o;return e.replace(r,i)}},68274:(e,t)=>{"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=void 0,t.getErrorCausalChain=function e(t){return t.cause?[t,...e(t.cause)]:[t]}},64609:function(e,t,n){"use strict";var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0}),t.getErrorCausalChain=t.applyTrailingSlash=t.blogPostContainerID=void 0,t.blogPostContainerID="__blog-post-container";var r=n(44356);Object.defineProperty(t,"applyTrailingSlash",{enumerable:!0,get:function(){return a(r).default}});var i=n(68274);Object.defineProperty(t,"getErrorCausalChain",{enumerable:!0,get:function(){return i.getErrorCausalChain}})},31513:(e,t,n)=>{"use strict";n.d(t,{zR:()=>x,TM:()=>E,yJ:()=>m,sC:()=>C,AO:()=>p});var a=n(58168);function r(e){return"/"===e.charAt(0)}function i(e,t){for(var n=t,a=n+1,r=e.length;a=0;p--){var m=o[p];"."===m?i(o,p):".."===m?(i(o,p),d++):d&&(i(o,p),d--)}if(!c)for(;d--;d)o.unshift("..");!c||""===o[0]||o[0]&&r(o[0])||o.unshift("");var f=o.join("/");return n&&"/"!==f.substr(-1)&&(f+="/"),f};var s=n(11561);function l(e){return"/"===e.charAt(0)?e:"/"+e}function c(e){return"/"===e.charAt(0)?e.substr(1):e}function u(e,t){return function(e,t){return 0===e.toLowerCase().indexOf(t.toLowerCase())&&-1!=="/?#".indexOf(e.charAt(t.length))}(e,t)?e.substr(t.length):e}function d(e){return"/"===e.charAt(e.length-1)?e.slice(0,-1):e}function p(e){var t=e.pathname,n=e.search,a=e.hash,r=t||"/";return n&&"?"!==n&&(r+="?"===n.charAt(0)?n:"?"+n),a&&"#"!==a&&(r+="#"===a.charAt(0)?a:"#"+a),r}function m(e,t,n,r){var i;"string"==typeof e?(i=function(e){var t=e||"/",n="",a="",r=t.indexOf("#");-1!==r&&(a=t.substr(r),t=t.substr(0,r));var i=t.indexOf("?");return-1!==i&&(n=t.substr(i),t=t.substr(0,i)),{pathname:t,search:"?"===n?"":n,hash:"#"===a?"":a}}(e),i.state=t):(void 0===(i=(0,a.A)({},e)).pathname&&(i.pathname=""),i.search?"?"!==i.search.charAt(0)&&(i.search="?"+i.search):i.search="",i.hash?"#"!==i.hash.charAt(0)&&(i.hash="#"+i.hash):i.hash="",void 0!==t&&void 0===i.state&&(i.state=t));try{i.pathname=decodeURI(i.pathname)}catch(s){throw s instanceof URIError?new URIError('Pathname "'+i.pathname+'" could not be decoded. This is likely caused by an invalid percent-encoding.'):s}return n&&(i.key=n),r?i.pathname?"/"!==i.pathname.charAt(0)&&(i.pathname=o(i.pathname,r.pathname)):i.pathname=r.pathname:i.pathname||(i.pathname="/"),i}function f(){var e=null;var t=[];return{setPrompt:function(t){return e=t,function(){e===t&&(e=null)}},confirmTransitionTo:function(t,n,a,r){if(null!=e){var i="function"==typeof e?e(t,n):e;"string"==typeof i?"function"==typeof a?a(i,r):r(!0):r(!1!==i)}else r(!0)},appendListener:function(e){var n=!0;function a(){n&&e.apply(void 0,arguments)}return t.push(a),function(){n=!1,t=t.filter((function(e){return e!==a}))}},notifyListeners:function(){for(var e=arguments.length,n=new Array(e),a=0;at?n.splice(t,n.length-t,r):n.push(r),d({action:a,location:r,index:t,entries:n})}}))},replace:function(e,t){var a="REPLACE",r=m(e,t,h(),x.location);u.confirmTransitionTo(r,a,n,(function(e){e&&(x.entries[x.index]=r,d({action:a,location:r}))}))},go:v,goBack:function(){v(-1)},goForward:function(){v(1)},canGo:function(e){var t=x.index+e;return t>=0&&t{"use strict";var a=n(44363),r={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},i={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},o={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},s={};function l(e){return a.isMemo(e)?o:s[e.$$typeof]||r}s[a.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},s[a.Memo]=o;var c=Object.defineProperty,u=Object.getOwnPropertyNames,d=Object.getOwnPropertySymbols,p=Object.getOwnPropertyDescriptor,m=Object.getPrototypeOf,f=Object.prototype;e.exports=function e(t,n,a){if("string"!=typeof n){if(f){var r=m(n);r&&r!==f&&e(t,r,a)}var o=u(n);d&&(o=o.concat(d(n)));for(var s=l(t),h=l(n),b=0;b{"use strict";e.exports=function(e,t,n,a,r,i,o,s){if(!e){var l;if(void 0===t)l=new Error("Minified exception occurred; use the non-minified dev environment for the full error message and additional helpful warnings.");else{var c=[n,a,r,i,o,s],u=0;(l=new Error(t.replace(/%s/g,(function(){return c[u++]})))).name="Invariant Violation"}throw l.framesToPop=1,l}}},64634:e=>{e.exports=Array.isArray||function(e){return"[object Array]"==Object.prototype.toString.call(e)}},689:function(e){e.exports=function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(e,t){for(var n=0;n1&&void 0!==arguments[1])||arguments[1],r=arguments.length>2&&void 0!==arguments[2]?arguments[2]:[],i=arguments.length>3&&void 0!==arguments[3]?arguments[3]:5e3;t(this,e),this.ctx=n,this.iframes=a,this.exclude=r,this.iframesTimeout=i}return n(e,[{key:"getContexts",value:function(){var e=[];return(void 0!==this.ctx&&this.ctx?NodeList.prototype.isPrototypeOf(this.ctx)?Array.prototype.slice.call(this.ctx):Array.isArray(this.ctx)?this.ctx:"string"==typeof this.ctx?Array.prototype.slice.call(document.querySelectorAll(this.ctx)):[this.ctx]:[]).forEach((function(t){var n=e.filter((function(e){return e.contains(t)})).length>0;-1!==e.indexOf(t)||n||e.push(t)})),e}},{key:"getIframeContents",value:function(e,t){var n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:function(){},a=void 0;try{var r=e.contentWindow;if(a=r.document,!r||!a)throw new Error("iframe inaccessible")}catch(i){n()}a&&t(a)}},{key:"isIframeBlank",value:function(e){var t="about:blank",n=e.getAttribute("src").trim();return e.contentWindow.location.href===t&&n!==t&&n}},{key:"observeIframeLoad",value:function(e,t,n){var a=this,r=!1,i=null,o=function o(){if(!r){r=!0,clearTimeout(i);try{a.isIframeBlank(e)||(e.removeEventListener("load",o),a.getIframeContents(e,t,n))}catch(s){n()}}};e.addEventListener("load",o),i=setTimeout(o,this.iframesTimeout)}},{key:"onIframeReady",value:function(e,t,n){try{"complete"===e.contentWindow.document.readyState?this.isIframeBlank(e)?this.observeIframeLoad(e,t,n):this.getIframeContents(e,t,n):this.observeIframeLoad(e,t,n)}catch(a){n()}}},{key:"waitForIframes",value:function(e,t){var n=this,a=0;this.forEachIframe(e,(function(){return!0}),(function(e){a++,n.waitForIframes(e.querySelector("html"),(function(){--a||t()}))}),(function(e){e||t()}))}},{key:"forEachIframe",value:function(t,n,a){var r=this,i=arguments.length>3&&void 0!==arguments[3]?arguments[3]:function(){},o=t.querySelectorAll("iframe"),s=o.length,l=0;o=Array.prototype.slice.call(o);var c=function(){--s<=0&&i(l)};s||c(),o.forEach((function(t){e.matches(t,r.exclude)?c():r.onIframeReady(t,(function(e){n(t)&&(l++,a(e)),c()}),c)}))}},{key:"createIterator",value:function(e,t,n){return document.createNodeIterator(e,t,n,!1)}},{key:"createInstanceOnIframe",value:function(t){return new e(t.querySelector("html"),this.iframes)}},{key:"compareNodeIframe",value:function(e,t,n){if(e.compareDocumentPosition(n)&Node.DOCUMENT_POSITION_PRECEDING){if(null===t)return!0;if(t.compareDocumentPosition(n)&Node.DOCUMENT_POSITION_FOLLOWING)return!0}return!1}},{key:"getIteratorNode",value:function(e){var t=e.previousNode();return{prevNode:t,node:(null===t||e.nextNode())&&e.nextNode()}}},{key:"checkIframeFilter",value:function(e,t,n,a){var r=!1,i=!1;return a.forEach((function(e,t){e.val===n&&(r=t,i=e.handled)})),this.compareNodeIframe(e,t,n)?(!1!==r||i?!1===r||i||(a[r].handled=!0):a.push({val:n,handled:!0}),!0):(!1===r&&a.push({val:n,handled:!1}),!1)}},{key:"handleOpenIframes",value:function(e,t,n,a){var r=this;e.forEach((function(e){e.handled||r.getIframeContents(e.val,(function(e){r.createInstanceOnIframe(e).forEachNode(t,n,a)}))}))}},{key:"iterateThroughNodes",value:function(e,t,n,a,r){for(var i=this,o=this.createIterator(t,e,a),s=[],l=[],c=void 0,u=void 0,d=function(){var e=i.getIteratorNode(o);return u=e.prevNode,c=e.node};d();)this.iframes&&this.forEachIframe(t,(function(e){return i.checkIframeFilter(c,u,e,s)}),(function(t){i.createInstanceOnIframe(t).forEachNode(e,(function(e){return l.push(e)}),a)})),l.push(c);l.forEach((function(e){n(e)})),this.iframes&&this.handleOpenIframes(s,e,n,a),r()}},{key:"forEachNode",value:function(e,t,n){var a=this,r=arguments.length>3&&void 0!==arguments[3]?arguments[3]:function(){},i=this.getContexts(),o=i.length;o||r(),i.forEach((function(i){var s=function(){a.iterateThroughNodes(e,i,t,n,(function(){--o<=0&&r()}))};a.iframes?a.waitForIframes(i,s):s()}))}}],[{key:"matches",value:function(e,t){var n="string"==typeof t?[t]:t,a=e.matches||e.matchesSelector||e.msMatchesSelector||e.mozMatchesSelector||e.oMatchesSelector||e.webkitMatchesSelector;if(a){var r=!1;return n.every((function(t){return!a.call(e,t)||(r=!0,!1)})),r}return!1}}]),e}(),i=function(){function i(e){t(this,i),this.ctx=e,this.ie=!1;var n=window.navigator.userAgent;(n.indexOf("MSIE")>-1||n.indexOf("Trident")>-1)&&(this.ie=!0)}return n(i,[{key:"log",value:function(t){var n=arguments.length>1&&void 0!==arguments[1]?arguments[1]:"debug",a=this.opt.log;this.opt.debug&&"object"===(void 0===a?"undefined":e(a))&&"function"==typeof a[n]&&a[n]("mark.js: "+t)}},{key:"escapeStr",value:function(e){return e.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g,"\\$&")}},{key:"createRegExp",value:function(e){return"disabled"!==this.opt.wildcards&&(e=this.setupWildcardsRegExp(e)),e=this.escapeStr(e),Object.keys(this.opt.synonyms).length&&(e=this.createSynonymsRegExp(e)),(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.setupIgnoreJoinersRegExp(e)),this.opt.diacritics&&(e=this.createDiacriticsRegExp(e)),e=this.createMergedBlanksRegExp(e),(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.createJoinersRegExp(e)),"disabled"!==this.opt.wildcards&&(e=this.createWildcardsRegExp(e)),e=this.createAccuracyRegExp(e)}},{key:"createSynonymsRegExp",value:function(e){var t=this.opt.synonyms,n=this.opt.caseSensitive?"":"i",a=this.opt.ignoreJoiners||this.opt.ignorePunctuation.length?"\0":"";for(var r in t)if(t.hasOwnProperty(r)){var i=t[r],o="disabled"!==this.opt.wildcards?this.setupWildcardsRegExp(r):this.escapeStr(r),s="disabled"!==this.opt.wildcards?this.setupWildcardsRegExp(i):this.escapeStr(i);""!==o&&""!==s&&(e=e.replace(new RegExp("("+this.escapeStr(o)+"|"+this.escapeStr(s)+")","gm"+n),a+"("+this.processSynomyms(o)+"|"+this.processSynomyms(s)+")"+a))}return e}},{key:"processSynomyms",value:function(e){return(this.opt.ignoreJoiners||this.opt.ignorePunctuation.length)&&(e=this.setupIgnoreJoinersRegExp(e)),e}},{key:"setupWildcardsRegExp",value:function(e){return(e=e.replace(/(?:\\)*\?/g,(function(e){return"\\"===e.charAt(0)?"?":"\x01"}))).replace(/(?:\\)*\*/g,(function(e){return"\\"===e.charAt(0)?"*":"\x02"}))}},{key:"createWildcardsRegExp",value:function(e){var t="withSpaces"===this.opt.wildcards;return e.replace(/\u0001/g,t?"[\\S\\s]?":"\\S?").replace(/\u0002/g,t?"[\\S\\s]*?":"\\S*")}},{key:"setupIgnoreJoinersRegExp",value:function(e){return e.replace(/[^(|)\\]/g,(function(e,t,n){var a=n.charAt(t+1);return/[(|)\\]/.test(a)||""===a?e:e+"\0"}))}},{key:"createJoinersRegExp",value:function(e){var t=[],n=this.opt.ignorePunctuation;return Array.isArray(n)&&n.length&&t.push(this.escapeStr(n.join(""))),this.opt.ignoreJoiners&&t.push("\\u00ad\\u200b\\u200c\\u200d"),t.length?e.split(/\u0000+/).join("["+t.join("")+"]*"):e}},{key:"createDiacriticsRegExp",value:function(e){var t=this.opt.caseSensitive?"":"i",n=this.opt.caseSensitive?["a\xe0\xe1\u1ea3\xe3\u1ea1\u0103\u1eb1\u1eaf\u1eb3\u1eb5\u1eb7\xe2\u1ea7\u1ea5\u1ea9\u1eab\u1ead\xe4\xe5\u0101\u0105","A\xc0\xc1\u1ea2\xc3\u1ea0\u0102\u1eb0\u1eae\u1eb2\u1eb4\u1eb6\xc2\u1ea6\u1ea4\u1ea8\u1eaa\u1eac\xc4\xc5\u0100\u0104","c\xe7\u0107\u010d","C\xc7\u0106\u010c","d\u0111\u010f","D\u0110\u010e","e\xe8\xe9\u1ebb\u1ebd\u1eb9\xea\u1ec1\u1ebf\u1ec3\u1ec5\u1ec7\xeb\u011b\u0113\u0119","E\xc8\xc9\u1eba\u1ebc\u1eb8\xca\u1ec0\u1ebe\u1ec2\u1ec4\u1ec6\xcb\u011a\u0112\u0118","i\xec\xed\u1ec9\u0129\u1ecb\xee\xef\u012b","I\xcc\xcd\u1ec8\u0128\u1eca\xce\xcf\u012a","l\u0142","L\u0141","n\xf1\u0148\u0144","N\xd1\u0147\u0143","o\xf2\xf3\u1ecf\xf5\u1ecd\xf4\u1ed3\u1ed1\u1ed5\u1ed7\u1ed9\u01a1\u1edf\u1ee1\u1edb\u1edd\u1ee3\xf6\xf8\u014d","O\xd2\xd3\u1ece\xd5\u1ecc\xd4\u1ed2\u1ed0\u1ed4\u1ed6\u1ed8\u01a0\u1ede\u1ee0\u1eda\u1edc\u1ee2\xd6\xd8\u014c","r\u0159","R\u0158","s\u0161\u015b\u0219\u015f","S\u0160\u015a\u0218\u015e","t\u0165\u021b\u0163","T\u0164\u021a\u0162","u\xf9\xfa\u1ee7\u0169\u1ee5\u01b0\u1eeb\u1ee9\u1eed\u1eef\u1ef1\xfb\xfc\u016f\u016b","U\xd9\xda\u1ee6\u0168\u1ee4\u01af\u1eea\u1ee8\u1eec\u1eee\u1ef0\xdb\xdc\u016e\u016a","y\xfd\u1ef3\u1ef7\u1ef9\u1ef5\xff","Y\xdd\u1ef2\u1ef6\u1ef8\u1ef4\u0178","z\u017e\u017c\u017a","Z\u017d\u017b\u0179"]:["a\xe0\xe1\u1ea3\xe3\u1ea1\u0103\u1eb1\u1eaf\u1eb3\u1eb5\u1eb7\xe2\u1ea7\u1ea5\u1ea9\u1eab\u1ead\xe4\xe5\u0101\u0105A\xc0\xc1\u1ea2\xc3\u1ea0\u0102\u1eb0\u1eae\u1eb2\u1eb4\u1eb6\xc2\u1ea6\u1ea4\u1ea8\u1eaa\u1eac\xc4\xc5\u0100\u0104","c\xe7\u0107\u010dC\xc7\u0106\u010c","d\u0111\u010fD\u0110\u010e","e\xe8\xe9\u1ebb\u1ebd\u1eb9\xea\u1ec1\u1ebf\u1ec3\u1ec5\u1ec7\xeb\u011b\u0113\u0119E\xc8\xc9\u1eba\u1ebc\u1eb8\xca\u1ec0\u1ebe\u1ec2\u1ec4\u1ec6\xcb\u011a\u0112\u0118","i\xec\xed\u1ec9\u0129\u1ecb\xee\xef\u012bI\xcc\xcd\u1ec8\u0128\u1eca\xce\xcf\u012a","l\u0142L\u0141","n\xf1\u0148\u0144N\xd1\u0147\u0143","o\xf2\xf3\u1ecf\xf5\u1ecd\xf4\u1ed3\u1ed1\u1ed5\u1ed7\u1ed9\u01a1\u1edf\u1ee1\u1edb\u1edd\u1ee3\xf6\xf8\u014dO\xd2\xd3\u1ece\xd5\u1ecc\xd4\u1ed2\u1ed0\u1ed4\u1ed6\u1ed8\u01a0\u1ede\u1ee0\u1eda\u1edc\u1ee2\xd6\xd8\u014c","r\u0159R\u0158","s\u0161\u015b\u0219\u015fS\u0160\u015a\u0218\u015e","t\u0165\u021b\u0163T\u0164\u021a\u0162","u\xf9\xfa\u1ee7\u0169\u1ee5\u01b0\u1eeb\u1ee9\u1eed\u1eef\u1ef1\xfb\xfc\u016f\u016bU\xd9\xda\u1ee6\u0168\u1ee4\u01af\u1eea\u1ee8\u1eec\u1eee\u1ef0\xdb\xdc\u016e\u016a","y\xfd\u1ef3\u1ef7\u1ef9\u1ef5\xffY\xdd\u1ef2\u1ef6\u1ef8\u1ef4\u0178","z\u017e\u017c\u017aZ\u017d\u017b\u0179"],a=[];return e.split("").forEach((function(r){n.every((function(n){if(-1!==n.indexOf(r)){if(a.indexOf(n)>-1)return!1;e=e.replace(new RegExp("["+n+"]","gm"+t),"["+n+"]"),a.push(n)}return!0}))})),e}},{key:"createMergedBlanksRegExp",value:function(e){return e.replace(/[\s]+/gim,"[\\s]+")}},{key:"createAccuracyRegExp",value:function(e){var t=this,n="!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~\xa1\xbf",a=this.opt.accuracy,r="string"==typeof a?a:a.value,i="string"==typeof a?[]:a.limiters,o="";switch(i.forEach((function(e){o+="|"+t.escapeStr(e)})),r){case"partially":default:return"()("+e+")";case"complementary":return"()([^"+(o="\\s"+(o||this.escapeStr(n)))+"]*"+e+"[^"+o+"]*)";case"exactly":return"(^|\\s"+o+")("+e+")(?=$|\\s"+o+")"}}},{key:"getSeparatedKeywords",value:function(e){var t=this,n=[];return e.forEach((function(e){t.opt.separateWordSearch?e.split(" ").forEach((function(e){e.trim()&&-1===n.indexOf(e)&&n.push(e)})):e.trim()&&-1===n.indexOf(e)&&n.push(e)})),{keywords:n.sort((function(e,t){return t.length-e.length})),length:n.length}}},{key:"isNumeric",value:function(e){return Number(parseFloat(e))==e}},{key:"checkRanges",value:function(e){var t=this;if(!Array.isArray(e)||"[object Object]"!==Object.prototype.toString.call(e[0]))return this.log("markRanges() will only accept an array of objects"),this.opt.noMatch(e),[];var n=[],a=0;return e.sort((function(e,t){return e.start-t.start})).forEach((function(e){var r=t.callNoMatchOnInvalidRanges(e,a),i=r.start,o=r.end;r.valid&&(e.start=i,e.length=o-i,n.push(e),a=o)})),n}},{key:"callNoMatchOnInvalidRanges",value:function(e,t){var n=void 0,a=void 0,r=!1;return e&&void 0!==e.start?(a=(n=parseInt(e.start,10))+parseInt(e.length,10),this.isNumeric(e.start)&&this.isNumeric(e.length)&&a-t>0&&a-n>0?r=!0:(this.log("Ignoring invalid or overlapping range: "+JSON.stringify(e)),this.opt.noMatch(e))):(this.log("Ignoring invalid range: "+JSON.stringify(e)),this.opt.noMatch(e)),{start:n,end:a,valid:r}}},{key:"checkWhitespaceRanges",value:function(e,t,n){var a=void 0,r=!0,i=n.length,o=t-i,s=parseInt(e.start,10)-o;return(a=(s=s>i?i:s)+parseInt(e.length,10))>i&&(a=i,this.log("End range automatically set to the max value of "+i)),s<0||a-s<0||s>i||a>i?(r=!1,this.log("Invalid range: "+JSON.stringify(e)),this.opt.noMatch(e)):""===n.substring(s,a).replace(/\s+/g,"")&&(r=!1,this.log("Skipping whitespace only range: "+JSON.stringify(e)),this.opt.noMatch(e)),{start:s,end:a,valid:r}}},{key:"getTextNodes",value:function(e){var t=this,n="",a=[];this.iterator.forEachNode(NodeFilter.SHOW_TEXT,(function(e){a.push({start:n.length,end:(n+=e.textContent).length,node:e})}),(function(e){return t.matchesExclude(e.parentNode)?NodeFilter.FILTER_REJECT:NodeFilter.FILTER_ACCEPT}),(function(){e({value:n,nodes:a})}))}},{key:"matchesExclude",value:function(e){return r.matches(e,this.opt.exclude.concat(["script","style","title","head","html"]))}},{key:"wrapRangeInTextNode",value:function(e,t,n){var a=this.opt.element?this.opt.element:"mark",r=e.splitText(t),i=r.splitText(n-t),o=document.createElement(a);return o.setAttribute("data-markjs","true"),this.opt.className&&o.setAttribute("class",this.opt.className),o.textContent=r.textContent,r.parentNode.replaceChild(o,r),i}},{key:"wrapRangeInMappedTextNode",value:function(e,t,n,a,r){var i=this;e.nodes.every((function(o,s){var l=e.nodes[s+1];if(void 0===l||l.start>t){if(!a(o.node))return!1;var c=t-o.start,u=(n>o.end?o.end:n)-o.start,d=e.value.substr(0,o.start),p=e.value.substr(u+o.start);if(o.node=i.wrapRangeInTextNode(o.node,c,u),e.value=d+p,e.nodes.forEach((function(t,n){n>=s&&(e.nodes[n].start>0&&n!==s&&(e.nodes[n].start-=u),e.nodes[n].end-=u)})),n-=u,r(o.node.previousSibling,o.start),!(n>o.end))return!1;t=o.end}return!0}))}},{key:"wrapMatches",value:function(e,t,n,a,r){var i=this,o=0===t?0:t+1;this.getTextNodes((function(t){t.nodes.forEach((function(t){t=t.node;for(var r=void 0;null!==(r=e.exec(t.textContent))&&""!==r[o];)if(n(r[o],t)){var s=r.index;if(0!==o)for(var l=1;l{"use strict";n.r(t)},58252:(e,t,n)=>{"use strict";n.r(t)},5947:function(e,t,n){var a,r;a=function(){var e,t,n={version:"0.2.0"},a=n.settings={minimum:.08,easing:"ease",positionUsing:"",speed:200,trickle:!0,trickleRate:.02,trickleSpeed:800,showSpinner:!0,barSelector:'[role="bar"]',spinnerSelector:'[role="spinner"]',parent:"body",template:'
'};function r(e,t,n){return en?n:e}function i(e){return 100*(-1+e)}function o(e,t,n){var r;return(r="translate3d"===a.positionUsing?{transform:"translate3d("+i(e)+"%,0,0)"}:"translate"===a.positionUsing?{transform:"translate("+i(e)+"%,0)"}:{"margin-left":i(e)+"%"}).transition="all "+t+"ms "+n,r}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(a[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=r(e,a.minimum,1),n.status=1===e?null:e;var i=n.render(!t),c=i.querySelector(a.barSelector),u=a.speed,d=a.easing;return i.offsetWidth,s((function(t){""===a.positionUsing&&(a.positionUsing=n.getPositioningCSS()),l(c,o(e,u,d)),1===e?(l(i,{transition:"none",opacity:1}),i.offsetWidth,setTimeout((function(){l(i,{transition:"all "+u+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),u)}),u)):setTimeout(t,u)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout((function(){n.status&&(n.trickle(),e())}),a.trickleSpeed)};return a.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*r(Math.random()*t,.1,.95)),t=r(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*a.trickleRate)},e=0,t=0,n.promise=function(a){return a&&"resolved"!==a.state()?(0===t&&n.start(),e++,t++,a.always((function(){0==--t?(e=0,n.done()):n.set((e-t)/e)})),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");u(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=a.template;var r,o=t.querySelector(a.barSelector),s=e?"-100":i(n.status||0),c=document.querySelector(a.parent);return l(o,{transition:"all 0 linear",transform:"translate3d("+s+"%,0,0)"}),a.showSpinner||(r=t.querySelector(a.spinnerSelector))&&m(r),c!=document.body&&u(c,"nprogress-custom-parent"),c.appendChild(t),t},n.remove=function(){d(document.documentElement,"nprogress-busy"),d(document.querySelector(a.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&m(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var s=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),l=function(){var e=["Webkit","O","Moz","ms"],t={};function n(e){return e.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()}))}function a(t){var n=document.body.style;if(t in n)return t;for(var a,r=e.length,i=t.charAt(0).toUpperCase()+t.slice(1);r--;)if((a=e[r]+i)in n)return a;return t}function r(e){return e=n(e),t[e]||(t[e]=a(e))}function i(e,t,n){t=r(t),e.style[t]=n}return function(e,t){var n,a,r=arguments;if(2==r.length)for(n in t)void 0!==(a=t[n])&&t.hasOwnProperty(n)&&i(e,n,a);else i(e,r[1],r[2])}}();function c(e,t){return("string"==typeof e?e:p(e)).indexOf(" "+t+" ")>=0}function u(e,t){var n=p(e),a=n+t;c(n,t)||(e.className=a.substring(1))}function d(e,t){var n,a=p(e);c(e,t)&&(n=a.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function p(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function m(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n},void 0===(r="function"==typeof a?a.call(t,n,t,e):a)||(e.exports=r)},35302:(e,t,n)=>{var a=n(64634);e.exports=m,e.exports.parse=i,e.exports.compile=function(e,t){return s(i(e,t),t)},e.exports.tokensToFunction=s,e.exports.tokensToRegExp=p;var r=new RegExp(["(\\\\.)","([\\/.])?(?:(?:\\:(\\w+)(?:\\(((?:\\\\.|[^\\\\()])+)\\))?|\\(((?:\\\\.|[^\\\\()])+)\\))([+*?])?|(\\*))"].join("|"),"g");function i(e,t){for(var n,a=[],i=0,o=0,s="",u=t&&t.delimiter||"/";null!=(n=r.exec(e));){var d=n[0],p=n[1],m=n.index;if(s+=e.slice(o,m),o=m+d.length,p)s+=p[1];else{var f=e[o],h=n[2],b=n[3],y=n[4],g=n[5],v=n[6],x=n[7];s&&(a.push(s),s="");var w=null!=h&&null!=f&&f!==h,S="+"===v||"*"===v,_="?"===v||"*"===v,k=n[2]||u,j=y||g;a.push({name:b||i++,prefix:h||"",delimiter:k,optional:_,repeat:S,partial:w,asterisk:!!x,pattern:j?c(j):x?".*":"[^"+l(k)+"]+?"})}}return o{e.exports&&(e.exports={core:{meta:{path:"components/prism-core.js",option:"mandatory"},core:"Core"},themes:{meta:{path:"themes/{id}.css",link:"index.html?theme={id}",exclusive:!0},prism:{title:"Default",option:"default"},"prism-dark":"Dark","prism-funky":"Funky","prism-okaidia":{title:"Okaidia",owner:"ocodia"},"prism-twilight":{title:"Twilight",owner:"remybach"},"prism-coy":{title:"Coy",owner:"tshedor"},"prism-solarizedlight":{title:"Solarized Light",owner:"hectormatos2011 "},"prism-tomorrow":{title:"Tomorrow Night",owner:"Rosey"}},languages:{meta:{path:"components/prism-{id}",noCSS:!0,examplesPath:"examples/prism-{id}",addCheckAll:!0},markup:{title:"Markup",alias:["html","xml","svg","mathml","ssml","atom","rss"],aliasTitles:{html:"HTML",xml:"XML",svg:"SVG",mathml:"MathML",ssml:"SSML",atom:"Atom",rss:"RSS"},option:"default"},css:{title:"CSS",option:"default",modify:"markup"},clike:{title:"C-like",option:"default"},javascript:{title:"JavaScript",require:"clike",modify:"markup",optional:"regex",alias:"js",option:"default"},abap:{title:"ABAP",owner:"dellagustin"},abnf:{title:"ABNF",owner:"RunDevelopment"},actionscript:{title:"ActionScript",require:"javascript",modify:"markup",owner:"Golmote"},ada:{title:"Ada",owner:"Lucretia"},agda:{title:"Agda",owner:"xy-ren"},al:{title:"AL",owner:"RunDevelopment"},antlr4:{title:"ANTLR4",alias:"g4",owner:"RunDevelopment"},apacheconf:{title:"Apache Configuration",owner:"GuiTeK"},apex:{title:"Apex",require:["clike","sql"],owner:"RunDevelopment"},apl:{title:"APL",owner:"ngn"},applescript:{title:"AppleScript",owner:"Golmote"},aql:{title:"AQL",owner:"RunDevelopment"},arduino:{title:"Arduino",require:"cpp",alias:"ino",owner:"dkern"},arff:{title:"ARFF",owner:"Golmote"},armasm:{title:"ARM Assembly",alias:"arm-asm",owner:"RunDevelopment"},arturo:{title:"Arturo",alias:"art",optional:["bash","css","javascript","markup","markdown","sql"],owner:"drkameleon"},asciidoc:{alias:"adoc",title:"AsciiDoc",owner:"Golmote"},aspnet:{title:"ASP.NET (C#)",require:["markup","csharp"],owner:"nauzilus"},asm6502:{title:"6502 Assembly",owner:"kzurawel"},asmatmel:{title:"Atmel AVR Assembly",owner:"cerkit"},autohotkey:{title:"AutoHotkey",owner:"aviaryan"},autoit:{title:"AutoIt",owner:"Golmote"},avisynth:{title:"AviSynth",alias:"avs",owner:"Zinfidel"},"avro-idl":{title:"Avro IDL",alias:"avdl",owner:"RunDevelopment"},awk:{title:"AWK",alias:"gawk",aliasTitles:{gawk:"GAWK"},owner:"RunDevelopment"},bash:{title:"Bash",alias:["sh","shell"],aliasTitles:{sh:"Shell",shell:"Shell"},owner:"zeitgeist87"},basic:{title:"BASIC",owner:"Golmote"},batch:{title:"Batch",owner:"Golmote"},bbcode:{title:"BBcode",alias:"shortcode",aliasTitles:{shortcode:"Shortcode"},owner:"RunDevelopment"},bbj:{title:"BBj",owner:"hyyan"},bicep:{title:"Bicep",owner:"johnnyreilly"},birb:{title:"Birb",require:"clike",owner:"Calamity210"},bison:{title:"Bison",require:"c",owner:"Golmote"},bnf:{title:"BNF",alias:"rbnf",aliasTitles:{rbnf:"RBNF"},owner:"RunDevelopment"},bqn:{title:"BQN",owner:"yewscion"},brainfuck:{title:"Brainfuck",owner:"Golmote"},brightscript:{title:"BrightScript",owner:"RunDevelopment"},bro:{title:"Bro",owner:"wayward710"},bsl:{title:"BSL (1C:Enterprise)",alias:"oscript",aliasTitles:{oscript:"OneScript"},owner:"Diversus23"},c:{title:"C",require:"clike",owner:"zeitgeist87"},csharp:{title:"C#",require:"clike",alias:["cs","dotnet"],owner:"mvalipour"},cpp:{title:"C++",require:"c",owner:"zeitgeist87"},cfscript:{title:"CFScript",require:"clike",alias:"cfc",owner:"mjclemente"},chaiscript:{title:"ChaiScript",require:["clike","cpp"],owner:"RunDevelopment"},cil:{title:"CIL",owner:"sbrl"},cilkc:{title:"Cilk/C",require:"c",alias:"cilk-c",owner:"OpenCilk"},cilkcpp:{title:"Cilk/C++",require:"cpp",alias:["cilk-cpp","cilk"],owner:"OpenCilk"},clojure:{title:"Clojure",owner:"troglotit"},cmake:{title:"CMake",owner:"mjrogozinski"},cobol:{title:"COBOL",owner:"RunDevelopment"},coffeescript:{title:"CoffeeScript",require:"javascript",alias:"coffee",owner:"R-osey"},concurnas:{title:"Concurnas",alias:"conc",owner:"jasontatton"},csp:{title:"Content-Security-Policy",owner:"ScottHelme"},cooklang:{title:"Cooklang",owner:"ahue"},coq:{title:"Coq",owner:"RunDevelopment"},crystal:{title:"Crystal",require:"ruby",owner:"MakeNowJust"},"css-extras":{title:"CSS Extras",require:"css",modify:"css",owner:"milesj"},csv:{title:"CSV",owner:"RunDevelopment"},cue:{title:"CUE",owner:"RunDevelopment"},cypher:{title:"Cypher",owner:"RunDevelopment"},d:{title:"D",require:"clike",owner:"Golmote"},dart:{title:"Dart",require:"clike",owner:"Golmote"},dataweave:{title:"DataWeave",owner:"machaval"},dax:{title:"DAX",owner:"peterbud"},dhall:{title:"Dhall",owner:"RunDevelopment"},diff:{title:"Diff",owner:"uranusjr"},django:{title:"Django/Jinja2",require:"markup-templating",alias:"jinja2",owner:"romanvm"},"dns-zone-file":{title:"DNS zone file",owner:"RunDevelopment",alias:"dns-zone"},docker:{title:"Docker",alias:"dockerfile",owner:"JustinBeckwith"},dot:{title:"DOT (Graphviz)",alias:"gv",optional:"markup",owner:"RunDevelopment"},ebnf:{title:"EBNF",owner:"RunDevelopment"},editorconfig:{title:"EditorConfig",owner:"osipxd"},eiffel:{title:"Eiffel",owner:"Conaclos"},ejs:{title:"EJS",require:["javascript","markup-templating"],owner:"RunDevelopment",alias:"eta",aliasTitles:{eta:"Eta"}},elixir:{title:"Elixir",owner:"Golmote"},elm:{title:"Elm",owner:"zwilias"},etlua:{title:"Embedded Lua templating",require:["lua","markup-templating"],owner:"RunDevelopment"},erb:{title:"ERB",require:["ruby","markup-templating"],owner:"Golmote"},erlang:{title:"Erlang",owner:"Golmote"},"excel-formula":{title:"Excel Formula",alias:["xlsx","xls"],owner:"RunDevelopment"},fsharp:{title:"F#",require:"clike",owner:"simonreynolds7"},factor:{title:"Factor",owner:"catb0t"},false:{title:"False",owner:"edukisto"},"firestore-security-rules":{title:"Firestore security rules",require:"clike",owner:"RunDevelopment"},flow:{title:"Flow",require:"javascript",owner:"Golmote"},fortran:{title:"Fortran",owner:"Golmote"},ftl:{title:"FreeMarker Template Language",require:"markup-templating",owner:"RunDevelopment"},gml:{title:"GameMaker Language",alias:"gamemakerlanguage",require:"clike",owner:"LiarOnce"},gap:{title:"GAP (CAS)",owner:"RunDevelopment"},gcode:{title:"G-code",owner:"RunDevelopment"},gdscript:{title:"GDScript",owner:"RunDevelopment"},gedcom:{title:"GEDCOM",owner:"Golmote"},gettext:{title:"gettext",alias:"po",owner:"RunDevelopment"},gherkin:{title:"Gherkin",owner:"hason"},git:{title:"Git",owner:"lgiraudel"},glsl:{title:"GLSL",require:"c",owner:"Golmote"},gn:{title:"GN",alias:"gni",owner:"RunDevelopment"},"linker-script":{title:"GNU Linker Script",alias:"ld",owner:"RunDevelopment"},go:{title:"Go",require:"clike",owner:"arnehormann"},"go-module":{title:"Go module",alias:"go-mod",owner:"RunDevelopment"},gradle:{title:"Gradle",require:"clike",owner:"zeabdelkhalek-badido18"},graphql:{title:"GraphQL",optional:"markdown",owner:"Golmote"},groovy:{title:"Groovy",require:"clike",owner:"robfletcher"},haml:{title:"Haml",require:"ruby",optional:["css","css-extras","coffeescript","erb","javascript","less","markdown","scss","textile"],owner:"Golmote"},handlebars:{title:"Handlebars",require:"markup-templating",alias:["hbs","mustache"],aliasTitles:{mustache:"Mustache"},owner:"Golmote"},haskell:{title:"Haskell",alias:"hs",owner:"bholst"},haxe:{title:"Haxe",require:"clike",optional:"regex",owner:"Golmote"},hcl:{title:"HCL",owner:"outsideris"},hlsl:{title:"HLSL",require:"c",owner:"RunDevelopment"},hoon:{title:"Hoon",owner:"matildepark"},http:{title:"HTTP",optional:["csp","css","hpkp","hsts","javascript","json","markup","uri"],owner:"danielgtaylor"},hpkp:{title:"HTTP Public-Key-Pins",owner:"ScottHelme"},hsts:{title:"HTTP Strict-Transport-Security",owner:"ScottHelme"},ichigojam:{title:"IchigoJam",owner:"BlueCocoa"},icon:{title:"Icon",owner:"Golmote"},"icu-message-format":{title:"ICU Message Format",owner:"RunDevelopment"},idris:{title:"Idris",alias:"idr",owner:"KeenS",require:"haskell"},ignore:{title:".ignore",owner:"osipxd",alias:["gitignore","hgignore","npmignore"],aliasTitles:{gitignore:".gitignore",hgignore:".hgignore",npmignore:".npmignore"}},inform7:{title:"Inform 7",owner:"Golmote"},ini:{title:"Ini",owner:"aviaryan"},io:{title:"Io",owner:"AlesTsurko"},j:{title:"J",owner:"Golmote"},java:{title:"Java",require:"clike",owner:"sherblot"},javadoc:{title:"JavaDoc",require:["markup","java","javadoclike"],modify:"java",optional:"scala",owner:"RunDevelopment"},javadoclike:{title:"JavaDoc-like",modify:["java","javascript","php"],owner:"RunDevelopment"},javastacktrace:{title:"Java stack trace",owner:"RunDevelopment"},jexl:{title:"Jexl",owner:"czosel"},jolie:{title:"Jolie",require:"clike",owner:"thesave"},jq:{title:"JQ",owner:"RunDevelopment"},jsdoc:{title:"JSDoc",require:["javascript","javadoclike","typescript"],modify:"javascript",optional:["actionscript","coffeescript"],owner:"RunDevelopment"},"js-extras":{title:"JS Extras",require:"javascript",modify:"javascript",optional:["actionscript","coffeescript","flow","n4js","typescript"],owner:"RunDevelopment"},json:{title:"JSON",alias:"webmanifest",aliasTitles:{webmanifest:"Web App Manifest"},owner:"CupOfTea696"},json5:{title:"JSON5",require:"json",owner:"RunDevelopment"},jsonp:{title:"JSONP",require:"json",owner:"RunDevelopment"},jsstacktrace:{title:"JS stack trace",owner:"sbrl"},"js-templates":{title:"JS Templates",require:"javascript",modify:"javascript",optional:["css","css-extras","graphql","markdown","markup","sql"],owner:"RunDevelopment"},julia:{title:"Julia",owner:"cdagnino"},keepalived:{title:"Keepalived Configure",owner:"dev-itsheng"},keyman:{title:"Keyman",owner:"mcdurdin"},kotlin:{title:"Kotlin",alias:["kt","kts"],aliasTitles:{kts:"Kotlin Script"},require:"clike",owner:"Golmote"},kumir:{title:"KuMir (\u041a\u0443\u041c\u0438\u0440)",alias:"kum",owner:"edukisto"},kusto:{title:"Kusto",owner:"RunDevelopment"},latex:{title:"LaTeX",alias:["tex","context"],aliasTitles:{tex:"TeX",context:"ConTeXt"},owner:"japborst"},latte:{title:"Latte",require:["clike","markup-templating","php"],owner:"nette"},less:{title:"Less",require:"css",optional:"css-extras",owner:"Golmote"},lilypond:{title:"LilyPond",require:"scheme",alias:"ly",owner:"RunDevelopment"},liquid:{title:"Liquid",require:"markup-templating",owner:"cinhtau"},lisp:{title:"Lisp",alias:["emacs","elisp","emacs-lisp"],owner:"JuanCaicedo"},livescript:{title:"LiveScript",owner:"Golmote"},llvm:{title:"LLVM IR",owner:"porglezomp"},log:{title:"Log file",optional:"javastacktrace",owner:"RunDevelopment"},lolcode:{title:"LOLCODE",owner:"Golmote"},lua:{title:"Lua",owner:"Golmote"},magma:{title:"Magma (CAS)",owner:"RunDevelopment"},makefile:{title:"Makefile",owner:"Golmote"},markdown:{title:"Markdown",require:"markup",optional:"yaml",alias:"md",owner:"Golmote"},"markup-templating":{title:"Markup templating",require:"markup",owner:"Golmote"},mata:{title:"Mata",owner:"RunDevelopment"},matlab:{title:"MATLAB",owner:"Golmote"},maxscript:{title:"MAXScript",owner:"RunDevelopment"},mel:{title:"MEL",owner:"Golmote"},mermaid:{title:"Mermaid",owner:"RunDevelopment"},metafont:{title:"METAFONT",owner:"LaeriExNihilo"},mizar:{title:"Mizar",owner:"Golmote"},mongodb:{title:"MongoDB",owner:"airs0urce",require:"javascript"},monkey:{title:"Monkey",owner:"Golmote"},moonscript:{title:"MoonScript",alias:"moon",owner:"RunDevelopment"},n1ql:{title:"N1QL",owner:"TMWilds"},n4js:{title:"N4JS",require:"javascript",optional:"jsdoc",alias:"n4jsd",owner:"bsmith-n4"},"nand2tetris-hdl":{title:"Nand To Tetris HDL",owner:"stephanmax"},naniscript:{title:"Naninovel Script",owner:"Elringus",alias:"nani"},nasm:{title:"NASM",owner:"rbmj"},neon:{title:"NEON",owner:"nette"},nevod:{title:"Nevod",owner:"nezaboodka"},nginx:{title:"nginx",owner:"volado"},nim:{title:"Nim",owner:"Golmote"},nix:{title:"Nix",owner:"Golmote"},nsis:{title:"NSIS",owner:"idleberg"},objectivec:{title:"Objective-C",require:"c",alias:"objc",owner:"uranusjr"},ocaml:{title:"OCaml",owner:"Golmote"},odin:{title:"Odin",owner:"edukisto"},opencl:{title:"OpenCL",require:"c",modify:["c","cpp"],owner:"Milania1"},openqasm:{title:"OpenQasm",alias:"qasm",owner:"RunDevelopment"},oz:{title:"Oz",owner:"Golmote"},parigp:{title:"PARI/GP",owner:"Golmote"},parser:{title:"Parser",require:"markup",owner:"Golmote"},pascal:{title:"Pascal",alias:"objectpascal",aliasTitles:{objectpascal:"Object Pascal"},owner:"Golmote"},pascaligo:{title:"Pascaligo",owner:"DefinitelyNotAGoat"},psl:{title:"PATROL Scripting Language",owner:"bertysentry"},pcaxis:{title:"PC-Axis",alias:"px",owner:"RunDevelopment"},peoplecode:{title:"PeopleCode",alias:"pcode",owner:"RunDevelopment"},perl:{title:"Perl",owner:"Golmote"},php:{title:"PHP",require:"markup-templating",owner:"milesj"},phpdoc:{title:"PHPDoc",require:["php","javadoclike"],modify:"php",owner:"RunDevelopment"},"php-extras":{title:"PHP Extras",require:"php",modify:"php",owner:"milesj"},"plant-uml":{title:"PlantUML",alias:"plantuml",owner:"RunDevelopment"},plsql:{title:"PL/SQL",require:"sql",owner:"Golmote"},powerquery:{title:"PowerQuery",alias:["pq","mscript"],owner:"peterbud"},powershell:{title:"PowerShell",owner:"nauzilus"},processing:{title:"Processing",require:"clike",owner:"Golmote"},prolog:{title:"Prolog",owner:"Golmote"},promql:{title:"PromQL",owner:"arendjr"},properties:{title:".properties",owner:"Golmote"},protobuf:{title:"Protocol Buffers",require:"clike",owner:"just-boris"},pug:{title:"Pug",require:["markup","javascript"],optional:["coffeescript","ejs","handlebars","less","livescript","markdown","scss","stylus","twig"],owner:"Golmote"},puppet:{title:"Puppet",owner:"Golmote"},pure:{title:"Pure",optional:["c","cpp","fortran"],owner:"Golmote"},purebasic:{title:"PureBasic",require:"clike",alias:"pbfasm",owner:"HeX0R101"},purescript:{title:"PureScript",require:"haskell",alias:"purs",owner:"sriharshachilakapati"},python:{title:"Python",alias:"py",owner:"multipetros"},qsharp:{title:"Q#",require:"clike",alias:"qs",owner:"fedonman"},q:{title:"Q (kdb+ database)",owner:"Golmote"},qml:{title:"QML",require:"javascript",owner:"RunDevelopment"},qore:{title:"Qore",require:"clike",owner:"temnroegg"},r:{title:"R",owner:"Golmote"},racket:{title:"Racket",require:"scheme",alias:"rkt",owner:"RunDevelopment"},cshtml:{title:"Razor C#",alias:"razor",require:["markup","csharp"],optional:["css","css-extras","javascript","js-extras"],owner:"RunDevelopment"},jsx:{title:"React JSX",require:["markup","javascript"],optional:["jsdoc","js-extras","js-templates"],owner:"vkbansal"},tsx:{title:"React TSX",require:["jsx","typescript"]},reason:{title:"Reason",require:"clike",owner:"Golmote"},regex:{title:"Regex",owner:"RunDevelopment"},rego:{title:"Rego",owner:"JordanSh"},renpy:{title:"Ren'py",alias:"rpy",owner:"HyuchiaDiego"},rescript:{title:"ReScript",alias:"res",owner:"vmarcosp"},rest:{title:"reST (reStructuredText)",owner:"Golmote"},rip:{title:"Rip",owner:"ravinggenius"},roboconf:{title:"Roboconf",owner:"Golmote"},robotframework:{title:"Robot Framework",alias:"robot",owner:"RunDevelopment"},ruby:{title:"Ruby",require:"clike",alias:"rb",owner:"samflores"},rust:{title:"Rust",owner:"Golmote"},sas:{title:"SAS",optional:["groovy","lua","sql"],owner:"Golmote"},sass:{title:"Sass (Sass)",require:"css",optional:"css-extras",owner:"Golmote"},scss:{title:"Sass (SCSS)",require:"css",optional:"css-extras",owner:"MoOx"},scala:{title:"Scala",require:"java",owner:"jozic"},scheme:{title:"Scheme",owner:"bacchus123"},"shell-session":{title:"Shell session",require:"bash",alias:["sh-session","shellsession"],owner:"RunDevelopment"},smali:{title:"Smali",owner:"RunDevelopment"},smalltalk:{title:"Smalltalk",owner:"Golmote"},smarty:{title:"Smarty",require:"markup-templating",optional:"php",owner:"Golmote"},sml:{title:"SML",alias:"smlnj",aliasTitles:{smlnj:"SML/NJ"},owner:"RunDevelopment"},solidity:{title:"Solidity (Ethereum)",alias:"sol",require:"clike",owner:"glachaud"},"solution-file":{title:"Solution file",alias:"sln",owner:"RunDevelopment"},soy:{title:"Soy (Closure Template)",require:"markup-templating",owner:"Golmote"},sparql:{title:"SPARQL",require:"turtle",owner:"Triply-Dev",alias:"rq"},"splunk-spl":{title:"Splunk SPL",owner:"RunDevelopment"},sqf:{title:"SQF: Status Quo Function (Arma 3)",require:"clike",owner:"RunDevelopment"},sql:{title:"SQL",owner:"multipetros"},squirrel:{title:"Squirrel",require:"clike",owner:"RunDevelopment"},stan:{title:"Stan",owner:"RunDevelopment"},stata:{title:"Stata Ado",require:["mata","java","python"],owner:"RunDevelopment"},iecst:{title:"Structured Text (IEC 61131-3)",owner:"serhioromano"},stylus:{title:"Stylus",owner:"vkbansal"},supercollider:{title:"SuperCollider",alias:"sclang",owner:"RunDevelopment"},swift:{title:"Swift",owner:"chrischares"},systemd:{title:"Systemd configuration file",owner:"RunDevelopment"},"t4-templating":{title:"T4 templating",owner:"RunDevelopment"},"t4-cs":{title:"T4 Text Templates (C#)",require:["t4-templating","csharp"],alias:"t4",owner:"RunDevelopment"},"t4-vb":{title:"T4 Text Templates (VB)",require:["t4-templating","vbnet"],owner:"RunDevelopment"},tap:{title:"TAP",owner:"isaacs",require:"yaml"},tcl:{title:"Tcl",owner:"PeterChaplin"},tt2:{title:"Template Toolkit 2",require:["clike","markup-templating"],owner:"gflohr"},textile:{title:"Textile",require:"markup",optional:"css",owner:"Golmote"},toml:{title:"TOML",owner:"RunDevelopment"},tremor:{title:"Tremor",alias:["trickle","troy"],owner:"darach",aliasTitles:{trickle:"trickle",troy:"troy"}},turtle:{title:"Turtle",alias:"trig",aliasTitles:{trig:"TriG"},owner:"jakubklimek"},twig:{title:"Twig",require:"markup-templating",owner:"brandonkelly"},typescript:{title:"TypeScript",require:"javascript",optional:"js-templates",alias:"ts",owner:"vkbansal"},typoscript:{title:"TypoScript",alias:"tsconfig",aliasTitles:{tsconfig:"TSConfig"},owner:"dkern"},unrealscript:{title:"UnrealScript",alias:["uscript","uc"],owner:"RunDevelopment"},uorazor:{title:"UO Razor Script",owner:"jaseowns"},uri:{title:"URI",alias:"url",aliasTitles:{url:"URL"},owner:"RunDevelopment"},v:{title:"V",require:"clike",owner:"taggon"},vala:{title:"Vala",require:"clike",optional:"regex",owner:"TemplarVolk"},vbnet:{title:"VB.Net",require:"basic",owner:"Bigsby"},velocity:{title:"Velocity",require:"markup",owner:"Golmote"},verilog:{title:"Verilog",owner:"a-rey"},vhdl:{title:"VHDL",owner:"a-rey"},vim:{title:"vim",owner:"westonganger"},"visual-basic":{title:"Visual Basic",alias:["vb","vba"],aliasTitles:{vba:"VBA"},owner:"Golmote"},warpscript:{title:"WarpScript",owner:"RunDevelopment"},wasm:{title:"WebAssembly",owner:"Golmote"},"web-idl":{title:"Web IDL",alias:"webidl",owner:"RunDevelopment"},wgsl:{title:"WGSL",owner:"Dr4gonthree"},wiki:{title:"Wiki markup",require:"markup",owner:"Golmote"},wolfram:{title:"Wolfram language",alias:["mathematica","nb","wl"],aliasTitles:{mathematica:"Mathematica",nb:"Mathematica Notebook"},owner:"msollami"},wren:{title:"Wren",owner:"clsource"},xeora:{title:"Xeora",require:"markup",alias:"xeoracube",aliasTitles:{xeoracube:"XeoraCube"},owner:"freakmaxi"},"xml-doc":{title:"XML doc (.net)",require:"markup",modify:["csharp","fsharp","vbnet"],owner:"RunDevelopment"},xojo:{title:"Xojo (REALbasic)",owner:"Golmote"},xquery:{title:"XQuery",require:"markup",owner:"Golmote"},yaml:{title:"YAML",alias:"yml",owner:"hason"},yang:{title:"YANG",owner:"RunDevelopment"},zig:{title:"Zig",owner:"RunDevelopment"}},plugins:{meta:{path:"plugins/{id}/prism-{id}",link:"plugins/{id}/"},"line-highlight":{title:"Line Highlight",description:"Highlights specific lines and/or line ranges."},"line-numbers":{title:"Line Numbers",description:"Line number at the beginning of code lines.",owner:"kuba-kubula"},"show-invisibles":{title:"Show Invisibles",description:"Show hidden characters such as tabs and line breaks.",optional:["autolinker","data-uri-highlight"]},autolinker:{title:"Autolinker",description:"Converts URLs and emails in code to clickable links. Parses Markdown links in comments."},wpd:{title:"WebPlatform Docs",description:'Makes tokens link to WebPlatform.org documentation. The links open in a new tab.'},"custom-class":{title:"Custom Class",description:"This plugin allows you to prefix Prism's default classes (.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},8722:(e,t,n)=>{const a=n(6969),r=n(98380),i=new Set;function o(e){void 0===e?e=Object.keys(a.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...i,...Object.keys(Prism.languages)];r(a,e,t).load((e=>{if(!(e in a.languages))return void(o.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(63157).resolve(t)],delete Prism.languages[e],n(63157)(t),i.add(e)}))}o.silent=!1,e.exports=o},19700:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,a,r,i){if(n.language===a){var o=n.tokenStack=[];n.code=n.code.replace(r,(function(e){if("function"==typeof i&&!i(e))return e;for(var r,s=o.length;-1!==n.code.indexOf(r=t(a,s));)++s;return o[s]=e,r})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,a){if(n.language===a&&n.tokenStack){n.grammar=e.languages[a];var r=0,i=Object.keys(n.tokenStack);!function o(s){for(var l=0;l=i.length);l++){var c=s[l];if("string"==typeof c||c.content&&"string"==typeof c.content){var u=i[r],d=n.tokenStack[u],p="string"==typeof c?c:c.content,m=t(a,u),f=p.indexOf(m);if(f>-1){++r;var h=p.substring(0,f),b=new e.Token(a,e.tokenize(d,n.grammar),"language-"+a,d),y=p.substring(f+m.length),g=[];h&&g.push.apply(g,o([h])),g.push(b),y&&g.push.apply(g,o([y])),"string"==typeof c?s.splice.apply(s,[l,1].concat(g)):c.content=g}}else c.content&&o(c.content)}return s}(n.tokens)}}}})}(Prism)},18692:(e,t,n)=>{var a={"./":8722};function r(e){var t=i(e);return n(t)}function i(e){if(!n.o(a,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return a[e]}r.keys=function(){return Object.keys(a)},r.resolve=i,e.exports=r,r.id=18692},63157:(e,t,n)=>{var a={"./":8722};function r(e){var t=i(e);return n(t)}function i(e){if(!n.o(a,e)){var t=new Error("Cannot find module '"+e+"'");throw t.code="MODULE_NOT_FOUND",t}return a[e]}r.keys=function(){return Object.keys(a)},r.resolve=i,e.exports=r,r.id=63157},98380:e=>{"use strict";var t=function(){var e=function(){};function t(e,t){Array.isArray(e)?e.forEach(t):null!=e&&t(e,0)}function n(e){for(var t={},n=0,a=e.length;n "));var s={},l=e[a];if(l){function c(t){if(!(t in e))throw new Error(a+" depends on an unknown component "+t);if(!(t in s))for(var o in r(t,i),s[t]=!0,n[t])s[o]=!0}t(l.require,c),t(l.optional,c),t(l.modify,c)}n[a]=s,i.pop()}}return function(e){var t=n[e];return t||(r(e,a),t=n[e]),t}}function r(e){for(var t in e)return!0;return!1}return function(i,o,s){var l=function(e){var t={};for(var n in e){var a=e[n];for(var r in a)if("meta"!=r){var i=a[r];t[r]="string"==typeof i?{title:i}:i}}return t}(i),c=function(e){var n;return function(a){if(a in e)return a;if(!n)for(var r in n={},e){var i=e[r];t(i&&i.alias,(function(t){if(t in n)throw new Error(t+" cannot be alias for both "+r+" and "+n[t]);if(t in e)throw new Error(t+" cannot be alias of "+r+" because it is a component.");n[t]=r}))}return n[a]||a}}(l);o=o.map(c),s=(s||[]).map(c);var u=n(o),d=n(s);o.forEach((function e(n){var a=l[n];t(a&&a.require,(function(t){t in d||(u[t]=!0,e(t))}))}));for(var p,m=a(l),f=u;r(f);){for(var h in p={},f){var b=l[h];t(b&&b.modify,(function(e){e in d&&(p[e]=!0)}))}for(var y in d)if(!(y in u))for(var g in m(y))if(g in u){p[y]=!0;break}for(var v in f=p)u[v]=!0}var x={getIds:function(){var e=[];return x.load((function(t){e.push(t)})),e},load:function(t,n){return function(t,n,a,r){var i=r?r.series:void 0,o=r?r.parallel:e,s={},l={};function c(e){if(e in s)return s[e];l[e]=!0;var r,u=[];for(var d in t(e))d in n&&u.push(d);if(0===u.length)r=a(e);else{var p=o(u.map((function(e){var t=c(e);return delete l[e],t})));i?r=i(p,(function(){return a(e)})):a(e)}return s[e]=r}for(var u in n)c(u);var d=[];for(var p in l)d.push(s[p]);return o(d)}(m,u,t,n)}};return x}}();e.exports=t},2694:(e,t,n)=>{"use strict";var a=n(6925);function r(){}function i(){}i.resetWarningCache=r,e.exports=function(){function e(e,t,n,r,i,o){if(o!==a){var s=new Error("Calling PropTypes validators directly is not supported by the `prop-types` package. Use PropTypes.checkPropTypes() to call them. Read more at http://fb.me/use-check-prop-types");throw s.name="Invariant Violation",s}}function t(){return e}e.isRequired=e;var n={array:e,bigint:e,bool:e,func:e,number:e,object:e,string:e,symbol:e,any:e,arrayOf:t,element:e,elementType:e,instanceOf:t,node:e,objectOf:t,oneOf:t,oneOfType:t,shape:t,exact:t,checkPropTypes:i,resetWarningCache:r};return n.PropTypes=n,n}},5556:(e,t,n)=>{e.exports=n(2694)()},6925:e=>{"use strict";e.exports="SECRET_DO_NOT_PASS_THIS_OR_YOU_WILL_BE_FIRED"},22551:(e,t,n)=>{"use strict";var a=n(96540),r=n(69982);function i(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;n