Skip to content

Commit

Permalink
docs: add jsdoc to listen options
Browse files Browse the repository at this point in the history
  • Loading branch information
kettanaito committed Sep 5, 2024
1 parent cb50d9a commit 38b0e27
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
13 changes: 13 additions & 0 deletions src/node/glossary.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,22 @@ import type {
} from '~/core/sharedOptions'

export interface ListenOptions extends SharedOptions {
/**
* Enable remote request resolution.
*
* With `remote` set to `true`, all the outgoing requests in this process
* will be forwarded to a remote process where `setupRemoteServer` was
* created to handle. If the remote process hasn't handled the request,
* it will be handled by whichever request handlers you have in this process.
*/
remote?:
| boolean
| {
/**
* Custom port number to synchronize this `setupServer` with
* the remote `setupRemoteServer`.
* @default 56957
*/
port?: number
}
}
Expand Down
5 changes: 5 additions & 0 deletions src/node/setupRemoteServer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ export function setupRemoteServer(
}

export interface SetupRemoteServerListenOptions {
/**
* Custom port number to synchronize this this `setupRemoteServer`
* with the regular `setupServer`.
* @default 56957
*/
port?: number
}

Expand Down

0 comments on commit 38b0e27

Please sign in to comment.