From f166fb40a90f69b12b3dd24d22ab671964214149 Mon Sep 17 00:00:00 2001 From: Arda TANRIKULU Date: Mon, 10 Aug 2020 18:58:49 -0400 Subject: [PATCH] [deploy_website] another attempt --- .github/workflows/website.yml | 2 - package.json | 3 +- scripts/build-api-docs.js | 1 - website/.gitignore | 3 ++ ...lo_engine_src_index_.apolloengineloader.md | 10 ++-- ...ers_code_file_src_index_.codefileloader.md | 12 ++--- .../_loaders_git_src_index_.gitloader.md | 12 ++--- ..._loaders_github_src_index_.githubloader.md | 10 ++-- ...aphql_file_src_index_.graphqlfileloader.md | 28 +++++------ ...ers_json_file_src_index_.jsonfileloader.md | 24 +++++----- ..._loaders_module_src_index_.moduleloader.md | 12 ++--- ..._loaders_prisma_src_index_.prismaloader.md | 46 +++++++++---------- .../_loaders_url_src_index_.urlloader.md | 28 +++++------ .../api/classes/_mock_src_index_.mocklist.md | 4 +- 14 files changed, 98 insertions(+), 97 deletions(-) diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml index 0ee5d0f4601..89ba452073a 100644 --- a/.github/workflows/website.yml +++ b/.github/workflows/website.yml @@ -40,8 +40,6 @@ jobs: ${{ runner.os }}-14-15-yarn- - name: Install Dependencies using Yarn run: yarn install && git checkout yarn.lock - - name: Build API Docs - run: yarn build:api-docs - name: Deploy 🚀 run: yarn deploy:website env: diff --git a/package.json b/package.json index 74318b2711a..42957587aa6 100644 --- a/package.json +++ b/package.json @@ -4,6 +4,7 @@ "description": "Useful tools to create and manipulate GraphQL schemas.", "private": true, "scripts": { + "predeploy:website": "yarn build:api-docs", "deploy:website": "cd website && yarn deploy", "ts:transpile": "tsc --project tsconfig.build.json", "build": "yarn ts:transpile && bob build", @@ -84,4 +85,4 @@ "resolutions": { "graphql": "15.3.0" } -} \ No newline at end of file +} diff --git a/scripts/build-api-docs.js b/scripts/build-api-docs.js index 6d2b8708be0..28c70fa045d 100644 --- a/scripts/build-api-docs.js +++ b/scripts/build-api-docs.js @@ -2,7 +2,6 @@ const fs = require('fs'); const path = require('path'); const rimraf = require('rimraf'); const TypeDoc = require('typedoc'); -const { transpileModule } = require('typescript'); const { execSync } = require('child_process'); // Where to generate the API docs diff --git a/website/.gitignore b/website/.gitignore index b2d6de30624..832e96996a5 100644 --- a/website/.gitignore +++ b/website/.gitignore @@ -18,3 +18,6 @@ npm-debug.log* yarn-debug.log* yarn-error.log* + +# Generated API Docs +/docs/api diff --git a/website/docs/api/classes/_loaders_apollo_engine_src_index_.apolloengineloader.md b/website/docs/api/classes/_loaders_apollo_engine_src_index_.apolloengineloader.md index a7bcd8b10f4..c703591b229 100644 --- a/website/docs/api/classes/_loaders_apollo_engine_src_index_.apolloengineloader.md +++ b/website/docs/api/classes/_loaders_apollo_engine_src_index_.apolloengineloader.md @@ -12,7 +12,7 @@ This loader loads a schema from Apollo Engine ## Implements -* [Loader](../interfaces/_utils_src_index_.loader.md)‹[ApolloEngineOptions](../interfaces/_loaders_apollo_engine_src_index_.apolloengineoptions.md)› +* [Loader](/docs/api/interfaces/_utils_src_index_.loader)‹[ApolloEngineOptions](/docs/api/interfaces/_loaders_apollo_engine_src_index_.apolloengineoptions)› ## Index @@ -54,7 +54,7 @@ ___ ### load -▸ **load**(`_`: "apollo-engine", `options`: [ApolloEngineOptions](../interfaces/_loaders_apollo_engine_src_index_.apolloengineoptions.md)): *Promise‹[Source](../interfaces/_utils_src_index_.source.md)›* +▸ **load**(`_`: "apollo-engine", `options`: [ApolloEngineOptions](/docs/api/interfaces/_loaders_apollo_engine_src_index_.apolloengineoptions)): *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)›* *Defined in [packages/loaders/apollo-engine/src/index.ts:36](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/apollo-engine/src/index.ts#L36)* @@ -63,9 +63,9 @@ ___ Name | Type | ------ | ------ | `_` | "apollo-engine" | -`options` | [ApolloEngineOptions](../interfaces/_loaders_apollo_engine_src_index_.apolloengineoptions.md) | +`options` | [ApolloEngineOptions](/docs/api/interfaces/_loaders_apollo_engine_src_index_.apolloengineoptions) | -**Returns:** *Promise‹[Source](../interfaces/_utils_src_index_.source.md)›* +**Returns:** *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)›* ___ @@ -83,7 +83,7 @@ ___ ▸ **loaderId**(): *string* -*Implementation of [Loader](../interfaces/_utils_src_index_.loader.md)* +*Implementation of [Loader](/docs/api/interfaces/_utils_src_index_.loader)* *Defined in [packages/loaders/apollo-engine/src/index.ts:24](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/apollo-engine/src/index.ts#L24)* diff --git a/website/docs/api/classes/_loaders_code_file_src_index_.codefileloader.md b/website/docs/api/classes/_loaders_code_file_src_index_.codefileloader.md index 599d6707d71..17999397071 100644 --- a/website/docs/api/classes/_loaders_code_file_src_index_.codefileloader.md +++ b/website/docs/api/classes/_loaders_code_file_src_index_.codefileloader.md @@ -23,7 +23,7 @@ Supported extensions include: `.ts`, `.tsx`, `.js`, `.jsx`, `.vue` ## Implements -* [Loader](../interfaces/_utils_src_index_.loader.md)‹[CodeFileLoaderOptions](../modules/_loaders_code_file_src_index_.md#codefileloaderoptions)› +* [Loader](/docs/api/interfaces/_utils_src_index_.loader)‹[CodeFileLoaderOptions](../modules/_loaders_code_file_src_index_.md#codefileloaderoptions)› ## Index @@ -73,7 +73,7 @@ ___ ### load -▸ **load**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [CodeFileLoaderOptions](../modules/_loaders_code_file_src_index_.md#codefileloaderoptions)): *Promise‹[Source](../interfaces/_utils_src_index_.source.md)›* +▸ **load**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [CodeFileLoaderOptions](../modules/_loaders_code_file_src_index_.md#codefileloaderoptions)): *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)›* *Defined in [packages/loaders/code-file/src/index.ts:80](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/code-file/src/index.ts#L80)* @@ -84,13 +84,13 @@ Name | Type | `pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle) | `options` | [CodeFileLoaderOptions](../modules/_loaders_code_file_src_index_.md#codefileloaderoptions) | -**Returns:** *Promise‹[Source](../interfaces/_utils_src_index_.source.md)›* +**Returns:** *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)›* ___ ### loadSync -▸ **loadSync**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [CodeFileLoaderOptions](../modules/_loaders_code_file_src_index_.md#codefileloaderoptions)): *[Source](../interfaces/_utils_src_index_.source.md)* +▸ **loadSync**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [CodeFileLoaderOptions](../modules/_loaders_code_file_src_index_.md#codefileloaderoptions)): *[Source](/docs/api/interfaces/_utils_src_index_.source)* *Defined in [packages/loaders/code-file/src/index.ts:123](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/code-file/src/index.ts#L123)* @@ -101,7 +101,7 @@ Name | Type | `pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle) | `options` | [CodeFileLoaderOptions](../modules/_loaders_code_file_src_index_.md#codefileloaderoptions) | -**Returns:** *[Source](../interfaces/_utils_src_index_.source.md)* +**Returns:** *[Source](/docs/api/interfaces/_utils_src_index_.source)* ___ @@ -109,7 +109,7 @@ ___ ▸ **loaderId**(): *string* -*Implementation of [Loader](../interfaces/_utils_src_index_.loader.md)* +*Implementation of [Loader](/docs/api/interfaces/_utils_src_index_.loader)* *Defined in [packages/loaders/code-file/src/index.ts:51](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/code-file/src/index.ts#L51)* diff --git a/website/docs/api/classes/_loaders_git_src_index_.gitloader.md b/website/docs/api/classes/_loaders_git_src_index_.gitloader.md index f97cbaffa84..92fec8006d5 100644 --- a/website/docs/api/classes/_loaders_git_src_index_.gitloader.md +++ b/website/docs/api/classes/_loaders_git_src_index_.gitloader.md @@ -18,7 +18,7 @@ const typeDefs = await loadTypedefs('git:someBranch:some/path/to/file.js', { ## Implements -* [Loader](../interfaces/_utils_src_index_.loader.md) +* [Loader](/docs/api/interfaces/_utils_src_index_.loader) ## Index @@ -66,7 +66,7 @@ ___ ### load -▸ **load**(`pointer`: string, `options`: [GitLoaderOptions](../modules/_loaders_git_src_index_.md#gitloaderoptions)): *Promise‹[Source](../interfaces/_utils_src_index_.source.md)›* +▸ **load**(`pointer`: string, `options`: [GitLoaderOptions](../modules/_loaders_git_src_index_.md#gitloaderoptions)): *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)›* *Defined in [packages/loaders/git/src/index.ts:62](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/git/src/index.ts#L62)* @@ -77,13 +77,13 @@ Name | Type | `pointer` | string | `options` | [GitLoaderOptions](../modules/_loaders_git_src_index_.md#gitloaderoptions) | -**Returns:** *Promise‹[Source](../interfaces/_utils_src_index_.source.md)›* +**Returns:** *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)›* ___ ### loadSync -▸ **loadSync**(`pointer`: string, `options`: [GitLoaderOptions](../modules/_loaders_git_src_index_.md#gitloaderoptions)): *[Source](../interfaces/_utils_src_index_.source.md)* +▸ **loadSync**(`pointer`: string, `options`: [GitLoaderOptions](../modules/_loaders_git_src_index_.md#gitloaderoptions)): *[Source](/docs/api/interfaces/_utils_src_index_.source)* *Defined in [packages/loaders/git/src/index.ts:79](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/git/src/index.ts#L79)* @@ -94,7 +94,7 @@ Name | Type | `pointer` | string | `options` | [GitLoaderOptions](../modules/_loaders_git_src_index_.md#gitloaderoptions) | -**Returns:** *[Source](../interfaces/_utils_src_index_.source.md)* +**Returns:** *[Source](/docs/api/interfaces/_utils_src_index_.source)* ___ @@ -102,7 +102,7 @@ ___ ▸ **loaderId**(): *string* -*Implementation of [Loader](../interfaces/_utils_src_index_.loader.md)* +*Implementation of [Loader](/docs/api/interfaces/_utils_src_index_.loader)* *Defined in [packages/loaders/git/src/index.ts:50](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/git/src/index.ts#L50)* diff --git a/website/docs/api/classes/_loaders_github_src_index_.githubloader.md b/website/docs/api/classes/_loaders_github_src_index_.githubloader.md index 41d9855b2b3..e81ea8ac393 100644 --- a/website/docs/api/classes/_loaders_github_src_index_.githubloader.md +++ b/website/docs/api/classes/_loaders_github_src_index_.githubloader.md @@ -19,7 +19,7 @@ const typeDefs = await loadTypedefs('github:githubUser/githubRepo#branchName:pat ## Implements -* [Loader](../interfaces/_utils_src_index_.loader.md)‹[GithubLoaderOptions](../interfaces/_loaders_github_src_index_.githubloaderoptions.md)› +* [Loader](/docs/api/interfaces/_utils_src_index_.loader)‹[GithubLoaderOptions](/docs/api/interfaces/_loaders_github_src_index_.githubloaderoptions)› ## Index @@ -61,7 +61,7 @@ ___ ### load -▸ **load**(`pointer`: string, `options`: [GithubLoaderOptions](../interfaces/_loaders_github_src_index_.githubloaderoptions.md)): *Promise‹[Source](../interfaces/_utils_src_index_.source.md) | object›* +▸ **load**(`pointer`: string, `options`: [GithubLoaderOptions](/docs/api/interfaces/_loaders_github_src_index_.githubloaderoptions)): *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source) | object›* *Defined in [packages/loaders/github/src/index.ts:63](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/github/src/index.ts#L63)* @@ -70,9 +70,9 @@ ___ Name | Type | ------ | ------ | `pointer` | string | -`options` | [GithubLoaderOptions](../interfaces/_loaders_github_src_index_.githubloaderoptions.md) | +`options` | [GithubLoaderOptions](/docs/api/interfaces/_loaders_github_src_index_.githubloaderoptions) | -**Returns:** *Promise‹[Source](../interfaces/_utils_src_index_.source.md) | object›* +**Returns:** *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source) | object›* ___ @@ -90,7 +90,7 @@ ___ ▸ **loaderId**(): *string* -*Implementation of [Loader](../interfaces/_utils_src_index_.loader.md)* +*Implementation of [Loader](/docs/api/interfaces/_utils_src_index_.loader)* *Defined in [packages/loaders/github/src/index.ts:51](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/github/src/index.ts#L51)* diff --git a/website/docs/api/classes/_loaders_graphql_file_src_index_.graphqlfileloader.md b/website/docs/api/classes/_loaders_graphql_file_src_index_.graphqlfileloader.md index cb1995b9037..c5ed8de10f9 100644 --- a/website/docs/api/classes/_loaders_graphql_file_src_index_.graphqlfileloader.md +++ b/website/docs/api/classes/_loaders_graphql_file_src_index_.graphqlfileloader.md @@ -32,7 +32,7 @@ const schema = await loadSchema('graphql/*.graphql', { ## Implements -* [Loader](../interfaces/_utils_src_index_.loader.md)‹[GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md)› +* [Loader](/docs/api/interfaces/_utils_src_index_.loader)‹[GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions)› ## Index @@ -49,7 +49,7 @@ const schema = await loadSchema('graphql/*.graphql', { ### canLoad -▸ **canLoad**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md)): *Promise‹boolean›* +▸ **canLoad**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions)): *Promise‹boolean›* *Defined in [packages/loaders/graphql-file/src/index.ts:62](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/graphql-file/src/index.ts#L62)* @@ -58,7 +58,7 @@ const schema = await loadSchema('graphql/*.graphql', { Name | Type | ------ | ------ | `pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle) | -`options` | [GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md) | +`options` | [GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions) | **Returns:** *Promise‹boolean›* @@ -66,7 +66,7 @@ ___ ### canLoadSync -▸ **canLoadSync**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md)): *boolean* +▸ **canLoadSync**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions)): *boolean* *Defined in [packages/loaders/graphql-file/src/index.ts:76](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/graphql-file/src/index.ts#L76)* @@ -75,7 +75,7 @@ ___ Name | Type | ------ | ------ | `pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle) | -`options` | [GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md) | +`options` | [GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions) | **Returns:** *boolean* @@ -83,7 +83,7 @@ ___ ### handleFileContent -▸ **handleFileContent**(`rawSDL`: string, `pointer`: string, `options`: [GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md)): *object | object* +▸ **handleFileContent**(`rawSDL`: string, `pointer`: string, `options`: [GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions)): *object | object* *Defined in [packages/loaders/graphql-file/src/index.ts:100](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/graphql-file/src/index.ts#L100)* @@ -93,7 +93,7 @@ Name | Type | ------ | ------ | `rawSDL` | string | `pointer` | string | -`options` | [GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md) | +`options` | [GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions) | **Returns:** *object | object* @@ -101,7 +101,7 @@ ___ ### load -▸ **load**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md)): *Promise‹[Source](../interfaces/_utils_src_index_.source.md)›* +▸ **load**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions)): *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)›* *Defined in [packages/loaders/graphql-file/src/index.ts:87](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/graphql-file/src/index.ts#L87)* @@ -110,15 +110,15 @@ ___ Name | Type | ------ | ------ | `pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle) | -`options` | [GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md) | +`options` | [GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions) | -**Returns:** *Promise‹[Source](../interfaces/_utils_src_index_.source.md)›* +**Returns:** *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)›* ___ ### loadSync -▸ **loadSync**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md)): *[Source](../interfaces/_utils_src_index_.source.md)* +▸ **loadSync**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle), `options`: [GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions)): *[Source](/docs/api/interfaces/_utils_src_index_.source)* *Defined in [packages/loaders/graphql-file/src/index.ts:94](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/graphql-file/src/index.ts#L94)* @@ -127,9 +127,9 @@ ___ Name | Type | ------ | ------ | `pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | [DocumentPointerSingle](../modules/_utils_src_index_.md#documentpointersingle) | -`options` | [GraphQLFileLoaderOptions](../interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions.md) | +`options` | [GraphQLFileLoaderOptions](/docs/api/interfaces/_loaders_graphql_file_src_index_.graphqlfileloaderoptions) | -**Returns:** *[Source](../interfaces/_utils_src_index_.source.md)* +**Returns:** *[Source](/docs/api/interfaces/_utils_src_index_.source)* ___ @@ -137,7 +137,7 @@ ___ ▸ **loaderId**(): *string* -*Implementation of [Loader](../interfaces/_utils_src_index_.loader.md)* +*Implementation of [Loader](/docs/api/interfaces/_utils_src_index_.loader)* *Defined in [packages/loaders/graphql-file/src/index.ts:58](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/graphql-file/src/index.ts#L58)* diff --git a/website/docs/api/classes/_loaders_json_file_src_index_.jsonfileloader.md b/website/docs/api/classes/_loaders_json_file_src_index_.jsonfileloader.md index 00f292cf3fa..a6110082a06 100644 --- a/website/docs/api/classes/_loaders_json_file_src_index_.jsonfileloader.md +++ b/website/docs/api/classes/_loaders_json_file_src_index_.jsonfileloader.md @@ -32,7 +32,7 @@ const documents = await loadDocuments('queries/*.json', { ## Implements -* [Loader](../interfaces/_utils_src_index_.loader.md) +* [Loader](/docs/api/interfaces/_utils_src_index_.loader) ## Index @@ -48,7 +48,7 @@ const documents = await loadDocuments('queries/*.json', { ### canLoad -▸ **canLoad**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `options`: [JsonFileLoaderOptions](../interfaces/_loaders_json_file_src_index_.jsonfileloaderoptions.md)): *Promise‹boolean›* +▸ **canLoad**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `options`: [JsonFileLoaderOptions](/docs/api/interfaces/_loaders_json_file_src_index_.jsonfileloaderoptions)): *Promise‹boolean›* *Defined in [packages/loaders/json-file/src/index.ts:48](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/json-file/src/index.ts#L48)* @@ -57,7 +57,7 @@ const documents = await loadDocuments('queries/*.json', { Name | Type | ------ | ------ | `pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | -`options` | [JsonFileLoaderOptions](../interfaces/_loaders_json_file_src_index_.jsonfileloaderoptions.md) | +`options` | [JsonFileLoaderOptions](/docs/api/interfaces/_loaders_json_file_src_index_.jsonfileloaderoptions) | **Returns:** *Promise‹boolean›* @@ -65,7 +65,7 @@ ___ ### canLoadSync -▸ **canLoadSync**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `options`: [JsonFileLoaderOptions](../interfaces/_loaders_json_file_src_index_.jsonfileloaderoptions.md)): *boolean* +▸ **canLoadSync**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `options`: [JsonFileLoaderOptions](/docs/api/interfaces/_loaders_json_file_src_index_.jsonfileloaderoptions)): *boolean* *Defined in [packages/loaders/json-file/src/index.ts:59](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/json-file/src/index.ts#L59)* @@ -74,7 +74,7 @@ ___ Name | Type | ------ | ------ | `pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | -`options` | [JsonFileLoaderOptions](../interfaces/_loaders_json_file_src_index_.jsonfileloaderoptions.md) | +`options` | [JsonFileLoaderOptions](/docs/api/interfaces/_loaders_json_file_src_index_.jsonfileloaderoptions) | **Returns:** *boolean* @@ -82,7 +82,7 @@ ___ ### load -▸ **load**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `options`: [JsonFileLoaderOptions](../interfaces/_loaders_json_file_src_index_.jsonfileloaderoptions.md)): *Promise‹[Source](../interfaces/_utils_src_index_.source.md)›* +▸ **load**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `options`: [JsonFileLoaderOptions](/docs/api/interfaces/_loaders_json_file_src_index_.jsonfileloaderoptions)): *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)›* *Defined in [packages/loaders/json-file/src/index.ts:71](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/json-file/src/index.ts#L71)* @@ -91,15 +91,15 @@ ___ Name | Type | ------ | ------ | `pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | -`options` | [JsonFileLoaderOptions](../interfaces/_loaders_json_file_src_index_.jsonfileloaderoptions.md) | +`options` | [JsonFileLoaderOptions](/docs/api/interfaces/_loaders_json_file_src_index_.jsonfileloaderoptions) | -**Returns:** *Promise‹[Source](../interfaces/_utils_src_index_.source.md)›* +**Returns:** *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)›* ___ ### loadSync -▸ **loadSync**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `options`: [JsonFileLoaderOptions](../interfaces/_loaders_json_file_src_index_.jsonfileloaderoptions.md)): *[Source](../interfaces/_utils_src_index_.source.md)* +▸ **loadSync**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `options`: [JsonFileLoaderOptions](/docs/api/interfaces/_loaders_json_file_src_index_.jsonfileloaderoptions)): *[Source](/docs/api/interfaces/_utils_src_index_.source)* *Defined in [packages/loaders/json-file/src/index.ts:82](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/json-file/src/index.ts#L82)* @@ -108,9 +108,9 @@ ___ Name | Type | ------ | ------ | `pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | -`options` | [JsonFileLoaderOptions](../interfaces/_loaders_json_file_src_index_.jsonfileloaderoptions.md) | +`options` | [JsonFileLoaderOptions](/docs/api/interfaces/_loaders_json_file_src_index_.jsonfileloaderoptions) | -**Returns:** *[Source](../interfaces/_utils_src_index_.source.md)* +**Returns:** *[Source](/docs/api/interfaces/_utils_src_index_.source)* ___ @@ -118,7 +118,7 @@ ___ ▸ **loaderId**(): *string* -*Implementation of [Loader](../interfaces/_utils_src_index_.loader.md)* +*Implementation of [Loader](/docs/api/interfaces/_utils_src_index_.loader)* *Defined in [packages/loaders/json-file/src/index.ts:44](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/json-file/src/index.ts#L44)* diff --git a/website/docs/api/classes/_loaders_module_src_index_.moduleloader.md b/website/docs/api/classes/_loaders_module_src_index_.moduleloader.md index 3a93464cbb3..c7c4e1d14d5 100644 --- a/website/docs/api/classes/_loaders_module_src_index_.moduleloader.md +++ b/website/docs/api/classes/_loaders_module_src_index_.moduleloader.md @@ -18,7 +18,7 @@ const schema = await loadSchema('module:someModuleName#someNamedExport', { ## Implements -* [Loader](../interfaces/_utils_src_index_.loader.md) +* [Loader](/docs/api/interfaces/_utils_src_index_.loader) ## Index @@ -66,7 +66,7 @@ ___ ### load -▸ **load**(`pointer`: string, `options`: [SingleFileOptions](../modules/_utils_src_index_.md#singlefileoptions)): *Promise‹[Source](../interfaces/_utils_src_index_.source.md)›* +▸ **load**(`pointer`: string, `options`: [SingleFileOptions](../modules/_utils_src_index_.md#singlefileoptions)): *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)›* *Defined in [packages/loaders/module/src/index.ts:55](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/module/src/index.ts#L55)* @@ -77,13 +77,13 @@ Name | Type | `pointer` | string | `options` | [SingleFileOptions](../modules/_utils_src_index_.md#singlefileoptions) | -**Returns:** *Promise‹[Source](../interfaces/_utils_src_index_.source.md)›* +**Returns:** *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)›* ___ ### loadSync -▸ **loadSync**(`pointer`: string, `options`: [SingleFileOptions](../modules/_utils_src_index_.md#singlefileoptions)): *[Source](../interfaces/_utils_src_index_.source.md)* +▸ **loadSync**(`pointer`: string, `options`: [SingleFileOptions](../modules/_utils_src_index_.md#singlefileoptions)): *[Source](/docs/api/interfaces/_utils_src_index_.source)* *Defined in [packages/loaders/module/src/index.ts:69](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/module/src/index.ts#L69)* @@ -94,7 +94,7 @@ Name | Type | `pointer` | string | `options` | [SingleFileOptions](../modules/_utils_src_index_.md#singlefileoptions) | -**Returns:** *[Source](../interfaces/_utils_src_index_.source.md)* +**Returns:** *[Source](/docs/api/interfaces/_utils_src_index_.source)* ___ @@ -102,7 +102,7 @@ ___ ▸ **loaderId**(): *string* -*Implementation of [Loader](../interfaces/_utils_src_index_.loader.md)* +*Implementation of [Loader](/docs/api/interfaces/_utils_src_index_.loader)* *Defined in [packages/loaders/module/src/index.ts:43](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/module/src/index.ts#L43)* diff --git a/website/docs/api/classes/_loaders_prisma_src_index_.prismaloader.md b/website/docs/api/classes/_loaders_prisma_src_index_.prismaloader.md index 2b9c73707d4..dc55cef2ad5 100644 --- a/website/docs/api/classes/_loaders_prisma_src_index_.prismaloader.md +++ b/website/docs/api/classes/_loaders_prisma_src_index_.prismaloader.md @@ -8,13 +8,13 @@ This loader loads a schema from a `prisma.yml` file ## Hierarchy -* [UrlLoader](_loaders_url_src_index_.urlloader.md) +* [UrlLoader](_loaders_url_src_index_.urlloader) ↳ **PrismaLoader** ## Implements -* [Loader](../interfaces/_utils_src_index_.loader.md)‹[LoadFromUrlOptions](../interfaces/_loaders_url_src_index_.loadfromurloptions.md)› +* [Loader](/docs/api/interfaces/_utils_src_index_.loader)‹[LoadFromUrlOptions](/docs/api/interfaces/_loaders_url_src_index_.loadfromurloptions)› ## Index @@ -36,7 +36,7 @@ This loader loads a schema from a `prisma.yml` file ▸ **buildAsyncExecutor**(`__namedParameters`: object): *AsyncExecutor* -*Inherited from [UrlLoader](_loaders_url_src_index_.urlloader.md).[buildAsyncExecutor](_loaders_url_src_index_.urlloader.md#buildasyncexecutor)* +*Inherited from [UrlLoader](_loaders_url_src_index_.urlloader).[buildAsyncExecutor](_loaders_url_src_index_.urlloader.md#buildasyncexecutor)* *Defined in [packages/loaders/url/src/index.ts:79](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/url/src/index.ts#L79)* @@ -60,7 +60,7 @@ ___ ▸ **buildSubscriber**(`pointer`: string, `webSocketImpl`: typeof w3cwebsocket): *Subscriber* -*Inherited from [UrlLoader](_loaders_url_src_index_.urlloader.md).[buildSubscriber](_loaders_url_src_index_.urlloader.md#buildsubscriber)* +*Inherited from [UrlLoader](_loaders_url_src_index_.urlloader).[buildSubscriber](_loaders_url_src_index_.urlloader.md#buildsubscriber)* *Defined in [packages/loaders/url/src/index.ts:136](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/url/src/index.ts#L136)* @@ -77,9 +77,9 @@ ___ ### canLoad -▸ **canLoad**(`prismaConfigFilePath`: string, `options`: [PrismaLoaderOptions](../interfaces/_loaders_prisma_src_index_.prismaloaderoptions.md)): *Promise‹boolean›* +▸ **canLoad**(`prismaConfigFilePath`: string, `options`: [PrismaLoaderOptions](/docs/api/interfaces/_loaders_prisma_src_index_.prismaloaderoptions)): *Promise‹boolean›* -*Overrides [UrlLoader](_loaders_url_src_index_.urlloader.md).[canLoad](_loaders_url_src_index_.urlloader.md#canload)* +*Overrides [UrlLoader](_loaders_url_src_index_.urlloader).[canLoad](_loaders_url_src_index_.urlloader.md#canload)* *Defined in [packages/loaders/prisma/src/index.ts:25](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/prisma/src/index.ts#L25)* @@ -88,7 +88,7 @@ ___ Name | Type | ------ | ------ | `prismaConfigFilePath` | string | -`options` | [PrismaLoaderOptions](../interfaces/_loaders_prisma_src_index_.prismaloaderoptions.md) | +`options` | [PrismaLoaderOptions](/docs/api/interfaces/_loaders_prisma_src_index_.prismaloaderoptions) | **Returns:** *Promise‹boolean›* @@ -96,9 +96,9 @@ ___ ### canLoadSync -▸ **canLoadSync**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `_options`: [LoadFromUrlOptions](../interfaces/_loaders_url_src_index_.loadfromurloptions.md)): *boolean* +▸ **canLoadSync**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `_options`: [LoadFromUrlOptions](/docs/api/interfaces/_loaders_url_src_index_.loadfromurloptions)): *boolean* -*Inherited from [UrlLoader](_loaders_url_src_index_.urlloader.md).[canLoadSync](_loaders_url_src_index_.urlloader.md#canloadsync)* +*Inherited from [UrlLoader](_loaders_url_src_index_.urlloader).[canLoadSync](_loaders_url_src_index_.urlloader.md#canloadsync)* *Defined in [packages/loaders/url/src/index.ts:75](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/url/src/index.ts#L75)* @@ -107,7 +107,7 @@ ___ Name | Type | ------ | ------ | `pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | -`_options` | [LoadFromUrlOptions](../interfaces/_loaders_url_src_index_.loadfromurloptions.md) | +`_options` | [LoadFromUrlOptions](/docs/api/interfaces/_loaders_url_src_index_.loadfromurloptions) | **Returns:** *boolean* @@ -115,9 +115,9 @@ ___ ### getExecutorAndSubscriber -▸ **getExecutorAndSubscriber**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `options`: [LoadFromUrlOptions](../interfaces/_loaders_url_src_index_.loadfromurloptions.md)): *Promise‹object›* +▸ **getExecutorAndSubscriber**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `options`: [LoadFromUrlOptions](/docs/api/interfaces/_loaders_url_src_index_.loadfromurloptions)): *Promise‹object›* -*Inherited from [UrlLoader](_loaders_url_src_index_.urlloader.md).[getExecutorAndSubscriber](_loaders_url_src_index_.urlloader.md#getexecutorandsubscriber)* +*Inherited from [UrlLoader](_loaders_url_src_index_.urlloader).[getExecutorAndSubscriber](_loaders_url_src_index_.urlloader.md#getexecutorandsubscriber)* *Defined in [packages/loaders/url/src/index.ts:149](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/url/src/index.ts#L149)* @@ -126,7 +126,7 @@ ___ Name | Type | ------ | ------ | `pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | -`options` | [LoadFromUrlOptions](../interfaces/_loaders_url_src_index_.loadfromurloptions.md) | +`options` | [LoadFromUrlOptions](/docs/api/interfaces/_loaders_url_src_index_.loadfromurloptions) | **Returns:** *Promise‹object›* @@ -134,9 +134,9 @@ ___ ### getSubschemaConfig -▸ **getSubschemaConfig**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `options`: [LoadFromUrlOptions](../interfaces/_loaders_url_src_index_.loadfromurloptions.md)): *Promise‹object›* +▸ **getSubschemaConfig**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `options`: [LoadFromUrlOptions](/docs/api/interfaces/_loaders_url_src_index_.loadfromurloptions)): *Promise‹object›* -*Inherited from [UrlLoader](_loaders_url_src_index_.urlloader.md).[getSubschemaConfig](_loaders_url_src_index_.urlloader.md#getsubschemaconfig)* +*Inherited from [UrlLoader](_loaders_url_src_index_.urlloader).[getSubschemaConfig](_loaders_url_src_index_.urlloader.md#getsubschemaconfig)* *Defined in [packages/loaders/url/src/index.ts:216](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/url/src/index.ts#L216)* @@ -145,7 +145,7 @@ ___ Name | Type | ------ | ------ | `pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | -`options` | [LoadFromUrlOptions](../interfaces/_loaders_url_src_index_.loadfromurloptions.md) | +`options` | [LoadFromUrlOptions](/docs/api/interfaces/_loaders_url_src_index_.loadfromurloptions) | **Returns:** *Promise‹object›* @@ -153,9 +153,9 @@ ___ ### load -▸ **load**(`prismaConfigFilePath`: string, `options`: [PrismaLoaderOptions](../interfaces/_loaders_prisma_src_index_.prismaloaderoptions.md)): *Promise‹[Source](../interfaces/_utils_src_index_.source.md)›* +▸ **load**(`prismaConfigFilePath`: string, `options`: [PrismaLoaderOptions](/docs/api/interfaces/_loaders_prisma_src_index_.prismaloaderoptions)): *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)›* -*Overrides [UrlLoader](_loaders_url_src_index_.urlloader.md).[load](_loaders_url_src_index_.urlloader.md#load)* +*Overrides [UrlLoader](_loaders_url_src_index_.urlloader).[load](_loaders_url_src_index_.urlloader.md#load)* *Defined in [packages/loaders/prisma/src/index.ts:33](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/prisma/src/index.ts#L33)* @@ -164,9 +164,9 @@ ___ Name | Type | ------ | ------ | `prismaConfigFilePath` | string | -`options` | [PrismaLoaderOptions](../interfaces/_loaders_prisma_src_index_.prismaloaderoptions.md) | +`options` | [PrismaLoaderOptions](/docs/api/interfaces/_loaders_prisma_src_index_.prismaloaderoptions) | -**Returns:** *Promise‹[Source](../interfaces/_utils_src_index_.source.md)›* +**Returns:** *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)›* ___ @@ -174,7 +174,7 @@ ___ ▸ **loadSync**(): *never* -*Inherited from [UrlLoader](_loaders_url_src_index_.urlloader.md).[loadSync](_loaders_url_src_index_.urlloader.md#loadsync)* +*Inherited from [UrlLoader](_loaders_url_src_index_.urlloader).[loadSync](_loaders_url_src_index_.urlloader.md#loadsync)* *Defined in [packages/loaders/url/src/index.ts:236](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/url/src/index.ts#L236)* @@ -186,9 +186,9 @@ ___ ▸ **loaderId**(): *string* -*Implementation of [Loader](../interfaces/_utils_src_index_.loader.md)* +*Implementation of [Loader](/docs/api/interfaces/_utils_src_index_.loader)* -*Overrides [UrlLoader](_loaders_url_src_index_.urlloader.md).[loaderId](_loaders_url_src_index_.urlloader.md#loaderid)* +*Overrides [UrlLoader](_loaders_url_src_index_.urlloader).[loaderId](_loaders_url_src_index_.urlloader.md#loaderid)* *Defined in [packages/loaders/prisma/src/index.ts:21](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/prisma/src/index.ts#L21)* diff --git a/website/docs/api/classes/_loaders_url_src_index_.urlloader.md b/website/docs/api/classes/_loaders_url_src_index_.urlloader.md index 824b2e2466b..68a2067cc76 100644 --- a/website/docs/api/classes/_loaders_url_src_index_.urlloader.md +++ b/website/docs/api/classes/_loaders_url_src_index_.urlloader.md @@ -19,11 +19,11 @@ const schema = await loadSchema('http://localhost:3000/graphql', { * **UrlLoader** - ↳ [PrismaLoader](_loaders_prisma_src_index_.prismaloader.md) + ↳ [PrismaLoader](_loaders_prisma_src_index_.prismaloader) ## Implements -* [Loader](../interfaces/_utils_src_index_.loader.md)‹[LoadFromUrlOptions](../interfaces/_loaders_url_src_index_.loadfromurloptions.md)› +* [Loader](/docs/api/interfaces/_utils_src_index_.loader)‹[LoadFromUrlOptions](/docs/api/interfaces/_loaders_url_src_index_.loadfromurloptions)› ## Index @@ -82,7 +82,7 @@ ___ ### canLoad -▸ **canLoad**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `options`: [LoadFromUrlOptions](../interfaces/_loaders_url_src_index_.loadfromurloptions.md)): *Promise‹boolean›* +▸ **canLoad**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `options`: [LoadFromUrlOptions](/docs/api/interfaces/_loaders_url_src_index_.loadfromurloptions)): *Promise‹boolean›* *Defined in [packages/loaders/url/src/index.ts:71](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/url/src/index.ts#L71)* @@ -91,7 +91,7 @@ ___ Name | Type | ------ | ------ | `pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | -`options` | [LoadFromUrlOptions](../interfaces/_loaders_url_src_index_.loadfromurloptions.md) | +`options` | [LoadFromUrlOptions](/docs/api/interfaces/_loaders_url_src_index_.loadfromurloptions) | **Returns:** *Promise‹boolean›* @@ -99,7 +99,7 @@ ___ ### canLoadSync -▸ **canLoadSync**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `_options`: [LoadFromUrlOptions](../interfaces/_loaders_url_src_index_.loadfromurloptions.md)): *boolean* +▸ **canLoadSync**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `_options`: [LoadFromUrlOptions](/docs/api/interfaces/_loaders_url_src_index_.loadfromurloptions)): *boolean* *Defined in [packages/loaders/url/src/index.ts:75](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/url/src/index.ts#L75)* @@ -108,7 +108,7 @@ ___ Name | Type | ------ | ------ | `pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | -`_options` | [LoadFromUrlOptions](../interfaces/_loaders_url_src_index_.loadfromurloptions.md) | +`_options` | [LoadFromUrlOptions](/docs/api/interfaces/_loaders_url_src_index_.loadfromurloptions) | **Returns:** *boolean* @@ -116,7 +116,7 @@ ___ ### getExecutorAndSubscriber -▸ **getExecutorAndSubscriber**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `options`: [LoadFromUrlOptions](../interfaces/_loaders_url_src_index_.loadfromurloptions.md)): *Promise‹object›* +▸ **getExecutorAndSubscriber**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `options`: [LoadFromUrlOptions](/docs/api/interfaces/_loaders_url_src_index_.loadfromurloptions)): *Promise‹object›* *Defined in [packages/loaders/url/src/index.ts:149](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/url/src/index.ts#L149)* @@ -125,7 +125,7 @@ ___ Name | Type | ------ | ------ | `pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | -`options` | [LoadFromUrlOptions](../interfaces/_loaders_url_src_index_.loadfromurloptions.md) | +`options` | [LoadFromUrlOptions](/docs/api/interfaces/_loaders_url_src_index_.loadfromurloptions) | **Returns:** *Promise‹object›* @@ -133,7 +133,7 @@ ___ ### getSubschemaConfig -▸ **getSubschemaConfig**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `options`: [LoadFromUrlOptions](../interfaces/_loaders_url_src_index_.loadfromurloptions.md)): *Promise‹object›* +▸ **getSubschemaConfig**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `options`: [LoadFromUrlOptions](/docs/api/interfaces/_loaders_url_src_index_.loadfromurloptions)): *Promise‹object›* *Defined in [packages/loaders/url/src/index.ts:216](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/url/src/index.ts#L216)* @@ -142,7 +142,7 @@ ___ Name | Type | ------ | ------ | `pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | -`options` | [LoadFromUrlOptions](../interfaces/_loaders_url_src_index_.loadfromurloptions.md) | +`options` | [LoadFromUrlOptions](/docs/api/interfaces/_loaders_url_src_index_.loadfromurloptions) | **Returns:** *Promise‹object›* @@ -150,7 +150,7 @@ ___ ### load -▸ **load**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `options`: [LoadFromUrlOptions](../interfaces/_loaders_url_src_index_.loadfromurloptions.md)): *Promise‹[Source](../interfaces/_utils_src_index_.source.md)›* +▸ **load**(`pointer`: [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle), `options`: [LoadFromUrlOptions](/docs/api/interfaces/_loaders_url_src_index_.loadfromurloptions)): *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)›* *Defined in [packages/loaders/url/src/index.ts:225](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/url/src/index.ts#L225)* @@ -159,9 +159,9 @@ ___ Name | Type | ------ | ------ | `pointer` | [SchemaPointerSingle](../modules/_utils_src_index_.md#schemapointersingle) | -`options` | [LoadFromUrlOptions](../interfaces/_loaders_url_src_index_.loadfromurloptions.md) | +`options` | [LoadFromUrlOptions](/docs/api/interfaces/_loaders_url_src_index_.loadfromurloptions) | -**Returns:** *Promise‹[Source](../interfaces/_utils_src_index_.source.md)›* +**Returns:** *Promise‹[Source](/docs/api/interfaces/_utils_src_index_.source)›* ___ @@ -179,7 +179,7 @@ ___ ▸ **loaderId**(): *string* -*Implementation of [Loader](../interfaces/_utils_src_index_.loader.md)* +*Implementation of [Loader](/docs/api/interfaces/_utils_src_index_.loader)* *Defined in [packages/loaders/url/src/index.ts:67](https://github.com/ardatan/graphql-tools/blob/master/packages/loaders/url/src/index.ts#L67)* diff --git a/website/docs/api/classes/_mock_src_index_.mocklist.md b/website/docs/api/classes/_mock_src_index_.mocklist.md index 6b4bc55e5d1..053d11c84c5 100644 --- a/website/docs/api/classes/_mock_src_index_.mocklist.md +++ b/website/docs/api/classes/_mock_src_index_.mocklist.md @@ -21,7 +21,7 @@ provided `mockFunction` once for each list item. ### constructor -\+ **new MockList**(`length`: number | Array‹number›, `mockFunction?`: GraphQLFieldResolver‹any, any›): *[MockList](_mock_src_index_.mocklist.md)* +\+ **new MockList**(`length`: number | Array‹number›, `mockFunction?`: GraphQLFieldResolver‹any, any›): *[MockList](_mock_src_index_.mocklist)* *Defined in [packages/mock/src/mocking.ts:367](https://github.com/ardatan/graphql-tools/blob/master/packages/mock/src/mocking.ts#L367)* @@ -32,4 +32,4 @@ Name | Type | Description | `length` | number | Array‹number› | Either the exact length of items to return or an inclusive range of possible lengths. | `mockFunction?` | GraphQLFieldResolver‹any, any› | The function to call for each item in the list to resolve it. It can return another MockList or a value. | -**Returns:** *[MockList](_mock_src_index_.mocklist.md)* +**Returns:** *[MockList](_mock_src_index_.mocklist)*