Options
All
  • Public
  • Public/Protected
  • All
Menu

@make-mjs/code — Reference

Index

Modules

Enumerations

Interfaces

Type aliases

Variables

Functions

Object literals

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 generateCode

generateCode: generate = generate

Functions

Const REJECTION_SILENCER

  • REJECTION_SILENCER(): void

convertUrlToPath

  • convertUrlToPath(url: string): string

fnAnd

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

  • 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

  • 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

fromDir

  • fromDir(options: Options): Promise<string>

fromFile

  • fromFile(options: Options): Promise<string>

fromFileWithoutChecking

  • fromFileWithoutChecking(options: OptionsWithoutForceMjs): string

getMjsUrl

isInternalModule

  • isInternalModule(options: Options): boolean

Const isMjsPackage

  • isMjsPackage(): false

Const isMjsUrl

  • isMjsUrl(options: Options): boolean

iterateAncestorDirectories

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

  • Parameters

    • path: string

    Returns Generator<string, void, unknown>

joinUrl

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

  • Like path.join but does not eliminate '.'

    Parameters

    • Rest ...urlSegments: string[]

      Paths to join together

    Returns string

mjsPackageTester

  • mjsPackageTester(mjsPackages: keyof string[]): Tester

mjsPackageTesterDef

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

nonMjsPackageTester

  • nonMjsPackageTester(nonMjsPackages: keyof string[]): Tester

nonMjsPackageTesterDef

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

Const parseCode

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

  • Parameters

    • code: string
    • Default value options: ParserOptions = OPTIONS

    Returns File

parseModuleUrl

removeTrailingSeparator

  • removeTrailingSeparator(path: string): string

  • 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

silenceRejection

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

  • Silence a unhandled promise rejection warning

    Type parameters

    • X

    Parameters

    • promise: Promise<X>

      Promise to silence

    Returns Promise<X>

transformCode

transformNode

traverseImportStatements

Object literals

Const DEFAULT_PARSER_OPTIONS

DEFAULT_PARSER_OPTIONS: object

plugins

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

sourceType

sourceType: "unambiguous" = "unambiguous"

Generated using TypeDoc