README.md

⚙️ mlly

ECMAScript module utilities.

Contents

• What is this?
• Install
• Use
• API
• Types
• Contribute

What is this?

mlly is a set of ECMAScript module (ESM) utilities. It exposes several tools to bridge the gap between developer experience and the current state of ECMAScript modules.

Install

This package is ESM only.

In Node.js (version 18+) with yarn:

yarn add @flex-development/mlly

See Git - Protocols | Yarn  for details regarding installing from Git.

In Deno with esm.sh:

import { resolveModule } from 'https://esm.sh/@flex-development/mlly'

In browsers with esm.sh:

<script type="module">
  import { resolveModule } from 'https://esm.sh/@flex-development/mlly'
</script>

Use

import {
  canParseUrl,
  cwd,
  defaultConditions,
  defaultExtensions,
  defaultMainFields,
  extensionFormatMap,
  formats,
  getSource,
  isAbsoluteSpecifier,
  isArrayIndex,
  isBareSpecifier,
  isDirectory,
  isFile,
  isImportsSubpath,
  isRelativeSpecifier,
  legacyMainResolve,
  lookupPackageScope,
  moduleResolve,
  packageExportsResolve,
  packageImportsExportsResolve,
  packageImportsResolve,
  packageResolve,
  packageSelfResolve,
  packageTargetResolve,
  patternKeyCompare,
  patternMatch,
  readPackageJson,
  resolveAlias,
  resolveModule,
  resolver,
  root,
  toRelativeSpecifier,
  toUrl
} from '@flex-development/mlly'

API

This package exports the following identifiers:

• canParseUrl
• cwd
• defaultConditions
• defaultExtensions
• defaultMainFields
• extensionFormatMap
• formats
• getSource
• isAbsoluteSpecifier
• isArrayIndex
• isBareSpecifier
• isDirectory
• isFile
• isImportsSubpath
• isRelativeSpecifier
• lookupPackageScope
• patternKeyCompare
• patternMatch
• readPackageJson
• resolveAlias
• resolveModule
• resolver
  • legacyMainResolve
  • moduleResolve
  • packageExportsResolve
  • packageImportsExportsResolve
  • packageImportsResolve
  • packageResolve
  • packageSelfResolve
  • packageTargetResolve
• root
• toRelativeSpecifier
• toUrl

There is no default export.

Types

This package is fully typed with TypeScript.

Interfaces

• Aliases
• FileSystem
• MainFieldMap
• ModuleFormatMap
• ResolveAliasOptions
• ResolveModuleOptions
• ProtocolMap
• Stats

Type Aliases

• ChangeExtFn
• MainField
• ModuleFormat
• ModuleId
• Numeric
• PatternKeyCompareResult
• PatternMatch
• Protocol

Contribute

See CONTRIBUTING.md.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.