Skip to content

Commit

Permalink
worker code excluded from typedoc
Browse files Browse the repository at this point in the history
  • Loading branch information
arietrouw committed Jun 27, 2023
1 parent 7b4f089 commit 966cbe9
Show file tree
Hide file tree
Showing 12 changed files with 19 additions and 8 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -106,4 +106,4 @@
"node": "18.13.0",
"yarn": "1.22.19"
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/* Used to exclude the worker code for typedoc */
export * from './defaultNodeManifest'
export * from './WorkerBridge'
export * from './WorkerBridgeConfig'
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"exclude": ["**/spec/*", "**/*.spec.*"],
"exclude": ["**/spec/*", "**/*.spec.*", "src/worker/*", "src/index.ts"],
"extends": "./tsconfig.json"
}

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$schema": "https://typedoc.org/schema.json",
"entryPoints": ["src/index.ts"],
"entryPoints": ["src/docsEntry.ts"],
"tsconfig": "./tsconfig.typedoc.json"
}
2 changes: 1 addition & 1 deletion packages/modules/packages/bridge/tsconfig.typedoc.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"exclude": ["**/spec/*", "**/*.spec.*"],
"exclude": ["**/spec/*", "**/*.spec.*", "**/worker/src/**/*"],
"extends": "./tsconfig.json"
}

Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
export * from './models'
export * from './ModuleWrapper'
2 changes: 1 addition & 1 deletion packages/modules/tsconfig.typedoc.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"exclude": ["**/spec/*", "**/*.spec.*"],
"exclude": ["**/spec/*", "**/*.spec.*", "**/worker/src/**/*"],
"extends": "./tsconfig.json"
}

1 change: 1 addition & 0 deletions packages/modules/typedoc.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"$schema": "https://typedoc.org/schema.json",
"entryPoints": ["src/index.ts"],
"exclude": ["**/WorkerNodeHost.ts"],
"tsconfig": "./tsconfig.typedoc.json"
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { NftInfo } from '@xyo-network/crypto-wallet-nft-payload-plugin'
import { scoringCriteria } from './criteria'
import { Score } from './score'

type ScoringCriteriaKey = keyof typeof scoringCriteria & PropertyKey
export type ScoringCriteriaKey = keyof typeof scoringCriteria & PropertyKey

export type NftAnalysis = {
[key in ScoringCriteriaKey]: Score
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { PreviousHashStore } from '@xyo-network/previous-hash-store-model'
import { DBSchema, IDBPDatabase, openDB } from 'idb'

interface PreviousHashStoreSchemaV1 extends DBSchema {
export interface PreviousHashStoreSchemaV1 extends DBSchema {
'previous-hash': {
key: string
value: string
Expand Down
6 changes: 5 additions & 1 deletion typedoc.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
{
"entryPoints": ["src/index.ts"],
"$schema": "https://typedoc.org/schema.json",
"entryPointStrategy": "packages",
"entryPoints": [
"packages/*"
],
"includeVersion": true,
"name": "XYO Platform Client SDK",
"tsconfig": "./tsconfig.typedoc.json"
Expand Down
1 change: 1 addition & 0 deletions typedoc.site.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"$schema": "https://typedoc.org/schema.json",
"entryPointStrategy": "packages",
"entryPoints": [
"**/packages/*"
Expand Down

0 comments on commit 966cbe9

Please sign in to comment.