Skip to content

Commit

Permalink
Added link to node docs in child process tsdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
tjcouch-sil committed Sep 9, 2024
1 parent 7e45dfd commit aa4820a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
8 changes: 8 additions & 0 deletions lib/papi-dts/papi.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5009,6 +5009,10 @@ declare module 'shared/models/create-process-privilege.model' {
* processes created this way in packaged builds. Child processes are not killed when running in
* development.
*
* This method is essentially a layer over the [`spawn`
* method](https://nodejs.org/api/child_process.html#child_processspawncommand-args-options) from
* the Node `child_process` module. Please see its documentation for more information.
*
* @example The following example assumes there are subdirectories in the extension's files for
* win32, linux, and macOS that include appropriate executables.
*
Expand Down Expand Up @@ -5051,6 +5055,10 @@ declare module 'shared/models/create-process-privilege.model' {
* processes created this way in packaged builds. Child processes are not killed when running in
* development.
*
* This method is essentially a layer over the [`fork`
* method](https://nodejs.org/api/child_process.html#child_processforkmodulepath-args-options) from
* the Node `child_process` module. Please see its documentation for more information.
*
* @example The following example assumes there is a file named `childProcess.js` in the extension's
* `assets` subdirectory
*
Expand Down
8 changes: 8 additions & 0 deletions src/shared/models/create-process-privilege.model.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ import { ExtensionBasicData } from '@shared/models/extension-basic-data.model';
* processes created this way in packaged builds. Child processes are not killed when running in
* development.
*
* This method is essentially a layer over the [`spawn`
* method](https://nodejs.org/api/child_process.html#child_processspawncommand-args-options) from
* the Node `child_process` module. Please see its documentation for more information.
*
* @example The following example assumes there are subdirectories in the extension's files for
* win32, linux, and macOS that include appropriate executables.
*
Expand Down Expand Up @@ -62,6 +66,10 @@ export type PlatformSpawn = (
* processes created this way in packaged builds. Child processes are not killed when running in
* development.
*
* This method is essentially a layer over the [`fork`
* method](https://nodejs.org/api/child_process.html#child_processforkmodulepath-args-options) from
* the Node `child_process` module. Please see its documentation for more information.
*
* @example The following example assumes there is a file named `childProcess.js` in the extension's
* `assets` subdirectory
*
Expand Down

0 comments on commit aa4820a

Please sign in to comment.