Skip to content

Commit

Permalink
docs(compartment-mapper): Improve docs for options (#2626)
Browse files Browse the repository at this point in the history
Small improvements to typedocs for some common options.
  • Loading branch information
kriskowal authored Nov 8, 2024
2 parents 6f7f196 + ee15dc8 commit aa6d4b3
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions packages/compartment-mapper/src/types/external.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,20 @@ export type MapNodeModulesOptions = MapNodeModulesOptionsOmitPolicy &
type MapNodeModulesOptionsOmitPolicy = Partial<{
/** @deprecated renamed `conditions` to be consistent with Node.js */
tags: Set<string>;
/**
* Conditions for package `"imports"` and `"exports"`.
* The `"development"` condition also implies that `devDependencies` of the
* entry package should be reachable.
* Common conditions include `"node"`, `"browser"`, `"require"`, `"import"`,
* and `"default"`.
* The conditions `"import"`, `"default"`, and `"endo"` need not be
* specified.
*/
conditions: Set<string>;
/**
* @deprecated Whether to make the devDependencies of the entry package
* accessible, implied by the `development` condition.
* @deprecated add `"development"` to the `conditions` Set option.
* Including `devDependencies` has been subsumed by implication
* of having the `"development"` condition.
*/
dev: boolean;
/** Dependencies to make reachable from any package */
Expand All @@ -66,7 +76,7 @@ type MapNodeModulesOptionsOmitPolicy = Partial<{
* Accounts for languages not present as values in any of the extension to
* language mappings.
* For higher level functions like `importLocation`, these are inferred
* from the `parses`.
* from the `parserForLanguage` option.
*/
languages: Array<Language>;
}>;
Expand Down

0 comments on commit aa6d4b3

Please sign in to comment.