@make-mjs/main — Reference

Index

Modules

Enumerations

Classes

Type aliases

Variables

Object literals

DEFAULT_PARSER_OPTIONS

Type aliases

FullMjsPathOptions

FullMjsPathOptions: Required<MjsPathOptions>

FullModulePathResolverOptions

FullModulePathResolverOptions: Required<ModulePathResolverOptions>

MaybePromise

MaybePromise<X>: X | Promise<X>

Type parameters

X

ModuleUrlParsingResult

ModuleUrlParsingResult: InternalModuleUrlParsingResult | ExternalModuleUrlParsingResult

Variables

Const DEFAULT_STAT_FUNC

DEFAULT_STAT_FUNC: StatFunc = lstat

Const generateCode

generateCode: generate = generate

Functions

Const DEFAULT_DEEP_FUNC

DEFAULT_DEEP_FUNC(x: Param): boolean

- Defined in main/lib/read.ts:15
Parameters
- x: Param
Returns boolean

Const DEFAULT_FILTER_FUNC

DEFAULT_FILTER_FUNC(x: Param): boolean

- Defined in main/lib/read.ts:13
Parameters
- x: Param
Returns boolean

Const DEFAULT_PATH_TRANSFORM_FUNC

DEFAULT_PATH_TRANSFORM_FUNC(path: string): string

- Defined in main/lib/transform.ts:12
Parameters
- path: string
Returns string

Const REJECTION_SILENCER

REJECTION_SILENCER(): void

- Defined in utils/index.ts:5
Returns void

convertUrlToPath

convertUrlToPath(url: string): string

- Defined in utils/index.ts:61
Parameters
- url: string
Returns string

fnAnd

fnAnd<X, Y, Z>(f: function, g: function): function

- Defined in utils/index.ts:92
Returns a function that takes an x, returns f(x) if f(x) is falsy or g(x) if f(x) is truthy

Type parameters
- X
- Y
- Z
Parameters
- f: function
  
  First function to call
  - - (x: X): Y
    - Parameters
      - x: X
      Returns Y
- g: function
  
  Second function to call
  - - (x: X): Z
    - Parameters
      - x: X
      Returns Z
Returns function
- - (x: X): Y | Z
  - Parameters
    - x: X
    Returns Y | Z

fnOr

fnOr<X, Y, Z>(f: function, g: function): function

- Defined in utils/index.ts:107
Returns a function that takes an x, returns f(x) if f(x) is truthy or g(x) if f(x) is falsy

Type parameters
- X
- Y
- Z
Parameters
- f: function
  
  First function to call
  - - (x: X): Y
    - Parameters
      - x: X
      Returns Y
- g: function
  
  Second function to call
  - - (x: X): Z
    - Parameters
      - x: X
      Returns Z
Returns function
- - (x: X): Y | Z
  - Parameters
    - x: X
    Returns Y | Z

formatCode

formatCode(code: string, options?: ReformatOptions): string

- Defined in code/lib/format-code.ts:9
Parameters
- code: string
- Default value options: ReformatOptions = {}
Returns string

fromDir

fromDir(options: Options): Promise<string>

- Defined in url/lib/from-dir.ts:13
Parameters
- options: Options
Returns Promise<string>

fromFile

fromFile(options: Options): Promise<string>

- Defined in url/lib/from-file.ts:26
Parameters
- options: Options
Returns Promise<string>

fromFileWithoutChecking

fromFileWithoutChecking(options: OptionsWithoutForceMjs): string

- Defined in url/lib/from-file.ts:11
Parameters
- options: OptionsWithoutForceMjs
Returns string

getMjsUrl

getMjsUrl(options: MjsPathOptions): Promise<string>

- Defined in url/lib/get-mjs-url.ts:32
Parameters
- options: MjsPathOptions
Returns Promise<string>

getModuleContainer

getModuleContainer(path: string, basename?: string): Generator<string, void, unknown>

- Defined in main/utils/get-module-container.ts:4
Parameters
- path: string
- Default value basename: string = "node_modules"
Returns Generator<string, void, unknown>

isInternalModule

isInternalModule(options: Options): boolean

- Defined in url/lib/is-internal-module.ts:5
Parameters
- options: Options
Returns boolean

Const isMjsPackage

isMjsPackage(): false

- Defined in url/lib/is-mjs-package.ts:1
Returns false

Const isMjsUrl

isMjsUrl(options: Options): boolean

- Defined in url/lib/is-mjs-url.ts:5
Parameters
- options: Options
Returns boolean

iterateAncestorDirectories

iterateAncestorDirectories(path: string): Generator<string, void, unknown>

- Defined in utils/index.ts:75
Parameters
- path: string
Returns Generator<string, void, unknown>

joinUrl

joinUrl(...urlSegments: string[]): string

- Defined in utils/index.ts:30
Like path.join but does not eliminate '.'

Parameters
- Rest ...urlSegments: string[]
  
  Paths to join together
Returns string

main

main(options: MainOptions): AsyncGenerator<BeforeWriteEvent | AfterWriteEvent, void, unknown>

- Defined in main/lib/main.ts:7
Parameters
- options: MainOptions
Returns AsyncGenerator<BeforeWriteEvent | AfterWriteEvent, void, unknown>

mjsPackageTester

mjsPackageTester(mjsPackages: keyof string[]): Tester

- Defined in url/lib/create-mjs-package-tester.ts:12
Parameters
- mjsPackages: keyof string[]
Returns Tester

mjsPackageTesterDef

mjsPackageTesterDef(mjsPackages: keyof string[], def?: Tester): Tester

- Defined in url/lib/create-mjs-package-tester.ts:16
Parameters
- mjsPackages: keyof string[]
- Default value def: Tester = DEFAULT
Returns Tester

nonMjsPackageTester

nonMjsPackageTester(nonMjsPackages: keyof string[]): Tester

- Defined in url/lib/create-mjs-package-tester.ts:23
Parameters
- nonMjsPackages: keyof string[]
Returns Tester

nonMjsPackageTesterDef

nonMjsPackageTesterDef(nonMjsPackages: keyof string[], def?: Tester): Tester

- Defined in url/lib/create-mjs-package-tester.ts:27
Parameters
- nonMjsPackages: keyof string[]
- Default value def: Tester = DEFAULT
Returns Tester

Const parseCode

parseCode(code: string, options?: ParserOptions): File

- Defined in code/lib/parse-code.ts:5
Parameters
- code: string
- Default value options: ParserOptions = OPTIONS
Returns File

parseModuleUrl

parseModuleUrl(path: string): ModuleUrlParsingResult

- Defined in url/lib/parse-module-url.ts:41
Parameters
- path: string
Returns ModuleUrlParsingResult

read

read(options: ReadOptions): AsyncGenerator<File, void>

- Defined in main/lib/read.ts:18
Parameters
- options: ReadOptions
Returns AsyncGenerator<File, void>

removeTrailingSeparator

removeTrailingSeparator(path: string): string

- Defined in utils/index.ts:20
Remove trailing '/' if there is one

Parameters
- path: string
  
  Path to be rid of trailing separator
Returns string

replacePathExtension

replacePathExtension(path: string, newExt: string): string

- Defined in utils/index.ts:71
Parameters
- path: string
- newExt: string
Returns string

silenceRejection

silenceRejection<X>(promise: Promise<X>): Promise<X>

- Defined in utils/index.ts:11
Silence a unhandled promise rejection warning

Type parameters
- X
Parameters
- promise: Promise<X>
  
  Promise to silence
Returns Promise<X>

transform

transform(options: TransformOptions): AsyncGenerator<File, void>

- Defined in main/lib/transform.ts:14
Parameters
- options: TransformOptions
Returns AsyncGenerator<File, void>

transformCode

transformCode(code: string, options: CodeTransformOptions): Promise<GeneratorResult>

- Defined in code/lib/transform.ts:51
Parameters
- code: string
- options: CodeTransformOptions
Returns Promise<GeneratorResult>

transformNode

transformNode(node: Node, options: NodeTransformOptions): Promise<void>

- Defined in code/lib/transform.ts:14
Parameters
- node: Node
- options: NodeTransformOptions
Returns Promise<void>

traverseImportStatements

traverseImportStatements(node: Node, options: TraversalOptions): void

- Defined in code/lib/traverse-import-statements.ts:40
Parameters
- node: Node
- options: TraversalOptions
Returns void

write

write(files: AsyncIterable<File>): AsyncGenerator<BeforeWriteEvent | AfterWriteEvent, void, unknown>

- Defined in main/lib/write.ts:22
Parameters
- files: AsyncIterable<File>
Returns AsyncGenerator<BeforeWriteEvent | AfterWriteEvent, void, unknown>

Object literals

Const DEFAULT_PARSER_OPTIONS

DEFAULT_PARSER_OPTIONS: object

plugins

plugins: ("dynamicImport" | "importMeta")[] = ['dynamicImport', 'importMeta']

sourceType

sourceType: "unambiguous" = "unambiguous"

Generated using TypeDoc