⚙️ mlly

ECMAScript module utilities.

Contents

• What is this?
• Install
• Use
• API
  • canParseUrl(input[, base])
  • cwd()
  • defaultConditions
  • defaultExtensions
  • defaultMainFields
  • extensionFormatMap
  • formats
  • getSource<T>(id[, options])
  • isAbsoluteSpecifier(value)
  • isArrayIndex(value)
  • isBareSpecifier(value)
  • isDirectory<T>(id[, fs])
  • isFile<T>(id[, fs])
  • isImportsSubpath(value)
  • isModuleId(value)
  • isRelativeSpecifier(value)
  • legacyMainResolve<T>(packageUrl[, manifest][, mainFields][, parent][, fs])
  • lookupPackageScope<T>(url[, end][, fs])
  • moduleResolve<T>(specifier, parent[, conditions][, mainFields][, preserveSymlinks][, fs])
  • packageExportsResolve<T>(packageUrl, subpath, exports[, conditions][, parent][, fs])
  • packageImportsExportsResolve<T>(matchKey, matchObject, packageUrl[, isImports][, conditions][, mainFields][, parent][, fs])
  • packageImportsResolve<T>(specifier, parent[, conditions][, mainFields][, fs])
  • packageResolve<T>(specifier, parent[, conditions][, mainFields][, fs])
  • packageSelfResolve<T>(name, subpath, parent[, conditions][, fs])
  • packageTargetResolve<T>(packageUrl, target, subpath[, patternMatch][, isImports][, conditions][, mainFields][, parent][, fs])
  • patternKeyCompare(a, b)
  • patternMatch(matchKey, matchObject)
  • readPackageJson<T>(id[, specifier][, parent][, fs])
  • resolveAlias(specifier[, options])
  • resolveModule<T>(specifier, parent[, options])
  • resolver
  • root
  • toRelativeSpecifier(url, parent)
  • toUrl(id[, parent])
• Types
  • Aliases
  • Awaitable<T>
  • ChangeExtFn
  • EmptyArray
  • EmptyObject
  • EmptyString
  • FileSystem
  • GetSourceContext
  • GetSourceHandler
  • GetSourceHandlers
  • GetSourceOptions
  • List<[T]>
  • MainFieldMap
  • MainField
  • ModuleFormatMap
  • ModuleFormat
  • ModuleId
  • Numeric
  • PatternKeyComparisonMap
  • PatternKeyComparison
  • PatternMatch
  • ProtocolMap
  • Protocol
  • ResolveAliasOptions
  • ResolveModuleOptions
  • Stats
• 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

TODO: use

API

TODO: api

canParseUrl(input[, base])

TODO: canParseUrl

cwd()

TODO: cwd

defaultConditions

TODO: defaultConditions

defaultExtensions

TODO: defaultExtensions

defaultMainFields

TODO: defaultMainFields

extensionFormatMap

TODO: extensionFormatMap

formats

TODO: formats

getSource<T>(id[, options])

TODO: getSource

isAbsoluteSpecifier(value)

TODO: isAbsoluteSpecifier

isArrayIndex(value)

TODO: isArrayIndex

isBareSpecifier(value)

TODO: isBareSpecifier

isDirectory<T>(id[, fs])

TODO: isDirectory

isFile<T>(id[, fs])

TODO: isFile

isImportsSubpath(value)

TODO: isImportsSubpath

isModuleId(value)

TODO: isModuleId

isRelativeSpecifier(value)

TODO: isRelativeSpecifier

legacyMainResolve<T>(packageUrl[, manifest][, mainFields][, parent][, fs])

TODO: legacyMainResolve

lookupPackageScope<T>(url[, end][, fs])

TODO: lookupPackageScope

moduleResolve<T>(specifier, parent[, conditions][, mainFields][, preserveSymlinks][, fs])

TODO: moduleResolve

packageExportsResolve<T>(packageUrl, subpath, exports[, conditions][, parent][, fs])

TODO: packageExportsResolve

packageImportsExportsResolve<T>(matchKey, matchObject, packageUrl[, isImports][, conditions][, mainFields][, parent][, fs])

TODO: packageImportsExportsResolve

packageImportsResolve<T>(specifier, parent[, conditions][, mainFields][, fs])

TODO: packageImportsResolve

packageResolve<T>(specifier, parent[, conditions][, mainFields][, fs])

TODO: packageResolve

packageSelfResolve<T>(name, subpath, parent[, conditions][, fs])

TODO: packageSelfResolve

packageTargetResolve<T>(packageUrl, target, subpath[, patternMatch][, isImports][, conditions][, mainFields][, parent][, fs])

TODO: packageTargetResolve

patternKeyCompare(a, b)

TODO: patternKeyCompare

patternMatch(matchKey, matchObject)

TODO: patternMatch

readPackageJson<T>(id[, specifier][, parent][, fs])

TODO: readPackageJson

resolveAlias(specifier[, options])

TODO: resolveAlias

resolveModule<T>(specifier, parent[, options])

TODO: resolveModule

resolver

An object containing resolution algorithm implementations.

• legacyMainResolve
• moduleResolve
• packageExportsResolve
• packageImportsExportsResolve
• packageImportsResolve
• packageResolve
• packageSelfResolve
• packageTargetResolve

root

TODO: root

toRelativeSpecifier(url, parent)

TODO: toRelativeSpecifier

toUrl(id[, parent])

TODO: toUrl

Types

This package is fully typed with TypeScript.

Aliases

TODO: Aliases

Awaitable<T>

TODO: Awaitable<T>

ChangeExtFn<[Ext]>

TODO: ChangeExtFn<[Ext]>

EmptyArray

TODO: EmptyArray

EmptyObject

TODO: EmptyObject

EmptyString

TODO: EmptyString

FileSystem

TODO: FileSystem

GetSourceContext

TODO: GetSourceContext

GetSourceHandler

TODO: GetSourceHandler

GetSourceHandlers

TODO: GetSourceHandlers

GetSourceOptions

TODO: GetSourceOptions

List<[T]>

TODO: List<[T]>

MainFieldMap

TODO: MainFieldMap

MainField

TODO: MainField

ModuleFormatMap

TODO: ModuleFormatMap

ModuleFormat

TODO: ModuleFormat

ModuleId

TODO: ModuleId

Numeric

TODO: Numeric

PatternKeyComparsionMap

TODO: PatternKeyComparsionMap

PatternKeyComparsion

TODO: PatternKeyComparsion

PatternMatch

TODO: PatternMatch

ProtocolMap

TODO: ProtocolMap

Protocol

TODO: Protocol

ResolveAliasOptions

TODO: ResolveAliasOptions

ResolveModuleOptions

TODO: ResolveModuleOptions

Stats

TODO: Stats

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.