Skip to content

Commit 30045bd

Browse files
jdillickjdillick
committed
Fix typedoc generation.
1 parent 9f50ab3 commit 30045bd

File tree

8 files changed

+88
-123
lines changed

8 files changed

+88
-123
lines changed

‎docs/assets/highlight.css

Lines changed: 42 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,30 @@
55
--dark-hl-1: #D4D4D4;
66
--light-hl-2: #A31515;
77
--dark-hl-2: #CE9178;
8-
--light-hl-3: #0000FF;
9-
--dark-hl-3: #569CD6;
8+
--light-hl-3: #AF00DB;
9+
--dark-hl-3: #C586C0;
1010
--light-hl-4: #001080;
1111
--dark-hl-4: #9CDCFE;
12-
--light-hl-5: #0070C1;
13-
--dark-hl-5: #4FC1FF;
14-
--light-hl-6: #000000;
15-
--dark-hl-6: #C8C8C8;
16-
--light-hl-7: #008000;
17-
--dark-hl-7: #6A9955;
18-
--light-hl-8: #AF00DB;
19-
--dark-hl-8: #C586C0;
20-
--light-hl-9: #267F99;
21-
--dark-hl-9: #4EC9B0;
22-
--light-hl-10: #098658;
23-
--dark-hl-10: #B5CEA8;
12+
--light-hl-5: #0000FF;
13+
--dark-hl-5: #569CD6;
14+
--light-hl-6: #0070C1;
15+
--dark-hl-6: #4FC1FF;
16+
--light-hl-7: #800000;
17+
--dark-hl-7: #808080;
18+
--light-hl-8: #800000;
19+
--dark-hl-8: #569CD6;
20+
--light-hl-9: #000000FF;
21+
--dark-hl-9: #D4D4D4;
22+
--light-hl-10: #E50000;
23+
--dark-hl-10: #9CDCFE;
24+
--light-hl-11: #008000;
25+
--dark-hl-11: #6A9955;
26+
--light-hl-12: #098658;
27+
--dark-hl-12: #B5CEA8;
28+
--light-hl-13: #267F99;
29+
--dark-hl-13: #4EC9B0;
30+
--light-hl-14: #000000;
31+
--dark-hl-14: #C8C8C8;
2432
--light-code-background: #FFFFFF;
2533
--dark-code-background: #1E1E1E;
2634
}
@@ -37,6 +45,10 @@
3745
--hl-8: var(--light-hl-8);
3846
--hl-9: var(--light-hl-9);
3947
--hl-10: var(--light-hl-10);
48+
--hl-11: var(--light-hl-11);
49+
--hl-12: var(--light-hl-12);
50+
--hl-13: var(--light-hl-13);
51+
--hl-14: var(--light-hl-14);
4052
--code-background: var(--light-code-background);
4153
} }
4254

@@ -52,6 +64,10 @@
5264
--hl-8: var(--dark-hl-8);
5365
--hl-9: var(--dark-hl-9);
5466
--hl-10: var(--dark-hl-10);
67+
--hl-11: var(--dark-hl-11);
68+
--hl-12: var(--dark-hl-12);
69+
--hl-13: var(--dark-hl-13);
70+
--hl-14: var(--dark-hl-14);
5571
--code-background: var(--dark-code-background);
5672
} }
5773

@@ -67,6 +83,10 @@
6783
--hl-8: var(--light-hl-8);
6884
--hl-9: var(--light-hl-9);
6985
--hl-10: var(--light-hl-10);
86+
--hl-11: var(--light-hl-11);
87+
--hl-12: var(--light-hl-12);
88+
--hl-13: var(--light-hl-13);
89+
--hl-14: var(--light-hl-14);
7090
--code-background: var(--light-code-background);
7191
}
7292

@@ -82,6 +102,10 @@
82102
--hl-8: var(--dark-hl-8);
83103
--hl-9: var(--dark-hl-9);
84104
--hl-10: var(--dark-hl-10);
105+
--hl-11: var(--dark-hl-11);
106+
--hl-12: var(--dark-hl-12);
107+
--hl-13: var(--dark-hl-13);
108+
--hl-14: var(--dark-hl-14);
85109
--code-background: var(--dark-code-background);
86110
}
87111

@@ -96,4 +120,8 @@
96120
.hl-8 { color: var(--hl-8); }
97121
.hl-9 { color: var(--hl-9); }
98122
.hl-10 { color: var(--hl-10); }
123+
.hl-11 { color: var(--hl-11); }
124+
.hl-12 { color: var(--hl-12); }
125+
.hl-13 { color: var(--hl-13); }
126+
.hl-14 { color: var(--hl-14); }
99127
pre, code { background: var(--code-background); }

‎docs/functions/useSyncQuery.html

Lines changed: 4 additions & 4 deletions
Large diffs are not rendered by default.

‎docs/index.html

Lines changed: 14 additions & 98 deletions
Large diffs are not rendered by default.

‎docs/modules.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Reactium-GraphQL-Plugin</title><meta name="description" content="Documentation for Reactium-GraphQL-Plugin"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">Reactium-GraphQL-Plugin</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>Reactium-GraphQL-Plugin</h2></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Functions</h3><div class="tsd-index-list"><a href="functions/useSyncQuery.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-64"></use></svg><span>use<wbr/>Sync<wbr/>Query</span></a>
2-
</div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>Reactium-GraphQL-Plugin</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
1+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@reactium/graphql</title><meta name="description" content="Documentation for @reactium/graphql"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@reactium/graphql</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>@reactium/graphql</h2></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Functions</h3><div class="tsd-index-list"><a href="functions/useSyncQuery.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-64"></use></svg><span>use<wbr/>Sync<wbr/>Query</span></a>
2+
</div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>@reactium/graphql</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

‎package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"local": "gulp local",
1212
"clean": "gulp clean",
1313
"graphql": "cd GraphQLServer; denon start",
14-
"typedoc": "npx typedoc --tsconfig reactium_modules/@reactium/graphql/tsconfig.json --out docs --readme ./readme.md reactium_modules/@reactium/graphql"
14+
"typedoc": "npx typedoc --tsconfig reactium_modules/@reactium/graphql/tsconfig.json --readme ./readme.md"
1515
},
1616
"keywords": [
1717
"react",

‎reactium_modules/@reactium/graphql/sdk.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ import {
1616
} from '@apollo/client';
1717

1818
/**
19-
* @description useSyncQuery is a hook that wraps the useLazyQuery hook from Apollo Client, and adds state management and event handling.
19+
* useSyncQuery is a hook that wraps the query hook from Apollo Client, and adds state management and event handling.
2020
* @param {DocumentNode | TypedDocumentNode<TData, TVariables>} query The GraphQL query document.
2121
* @param {LazyQueryHookOptions<NoInfer<TData>, NoInfer<TVariables>>} options Options to be passed to the useLazyQuery hook.
2222
* @param {'set' | 'change' | 'loaded' | 'refreshed' | string} [updateEvent='set'] The event name that triggers a rerender
2323
* @return {ReactiumSyncState<QueryResult<TData,TVariables>>} The sync state object.
24-
* @see {@link [useLazyQuery](https://www.apollographql.com/docs/react/api/react/hooks/#uselazyquery)} for more information on the useLazyQuery hook from which this hook is derived.
25-
* @see {@link [ReactiumSyncState](https://reactiumcore.github.io/reactium-sdk-core/classes/ReactiumSyncState.html)} to understand the underlying synchronized state object.
24+
* @see [useLazyQuery](https://www.apollographql.com/docs/react/api/react/hooks/#uselazyquery) for more information on the useLazyQuery hook from which this hook is derived.
25+
* @see [ReactiumSyncState](https://reactiumcore.github.io/reactium-sdk-core/classes/ReactiumSyncState.html) to understand the underlying synchronized state object.
2626
* @example
2727
* import { useSyncQuery } from '@reactium/graphql';
2828
* import { gql } from '@apollo/client';

‎readme.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Reactium GraphQL Plugin
22

3-
Provides an Apollo GraphQL client on Reactium.GraphQL singleton in Reactium project.
3+
Provides an Apollo GraphQL client to your Reactium project.
44

55
## About this Repository
66
This repository is a mono-style repo (for publishing the @reactium/graphql Reactium module to the Reactium registry), but it's also a Reactium project itself, complete with an example deno GraphQL server and a Reactium example front-end that uses the @reactium/graphql module.
@@ -15,6 +15,10 @@ To install this module in your own Reactium project:
1515
npx reactium install @reactium/graphql
1616
```
1717

18+
See [Configuration](#configuration) for environment variables to setup the plugin to work with your GraphQL server.
19+
20+
> By default looks for http://localhost:4000/graphql Change the `GRAPHQL_URL` environment variable if needed.
21+
1822
## Usage
1923

2024
See [Apollo Client (React)](https://www.apollographql.com/docs/react) documentation for full details.

‎typedoc.cjs

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
module.exports = {
2+
entryPoints: ['reactium_modules/@reactium/graphql/index.js'],
3+
out: 'docs',
4+
highlightLanguages: [
5+
'bash',
6+
'console',
7+
'css',
8+
'html',
9+
'javascript',
10+
'json',
11+
'jsonc',
12+
'json5',
13+
'tsx',
14+
'typescript',
15+
'jsx',
16+
],
17+
};

0 commit comments

Comments
 (0)