bundled

Documentation

Overview

Package bundled provides access to files bundled with TypeScript.

Index

• Constants
• Variables
• func LibPath() string
• func TestingLibPath() string
• func WrapFS(fs vfs.FS) vfs.FS

Constants

const Embedded = embedded

Embedded is true if the bundled files are implemented through an embedded FS.

Variables

var LibNames = []string{
	"lib.d.ts",
	"lib.decorators.d.ts",
	"lib.decorators.legacy.d.ts",
	"lib.dom.asynciterable.d.ts",
	"lib.dom.d.ts",
	"lib.dom.iterable.d.ts",
	"lib.es2015.collection.d.ts",
	"lib.es2015.core.d.ts",
	"lib.es2015.d.ts",
	"lib.es2015.generator.d.ts",
	"lib.es2015.iterable.d.ts",
	"lib.es2015.promise.d.ts",
	"lib.es2015.proxy.d.ts",
	"lib.es2015.reflect.d.ts",
	"lib.es2015.symbol.d.ts",
	"lib.es2015.symbol.wellknown.d.ts",
	"lib.es2016.array.include.d.ts",
	"lib.es2016.d.ts",
	"lib.es2016.full.d.ts",
	"lib.es2016.intl.d.ts",
	"lib.es2017.arraybuffer.d.ts",
	"lib.es2017.d.ts",
	"lib.es2017.date.d.ts",
	"lib.es2017.full.d.ts",
	"lib.es2017.intl.d.ts",
	"lib.es2017.object.d.ts",
	"lib.es2017.sharedmemory.d.ts",
	"lib.es2017.string.d.ts",
	"lib.es2017.typedarrays.d.ts",
	"lib.es2018.asyncgenerator.d.ts",
	"lib.es2018.asynciterable.d.ts",
	"lib.es2018.d.ts",
	"lib.es2018.full.d.ts",
	"lib.es2018.intl.d.ts",
	"lib.es2018.promise.d.ts",
	"lib.es2018.regexp.d.ts",
	"lib.es2019.array.d.ts",
	"lib.es2019.d.ts",
	"lib.es2019.full.d.ts",
	"lib.es2019.intl.d.ts",
	"lib.es2019.object.d.ts",
	"lib.es2019.string.d.ts",
	"lib.es2019.symbol.d.ts",
	"lib.es2020.bigint.d.ts",
	"lib.es2020.d.ts",
	"lib.es2020.date.d.ts",
	"lib.es2020.full.d.ts",
	"lib.es2020.intl.d.ts",
	"lib.es2020.number.d.ts",
	"lib.es2020.promise.d.ts",
	"lib.es2020.sharedmemory.d.ts",
	"lib.es2020.string.d.ts",
	"lib.es2020.symbol.wellknown.d.ts",
	"lib.es2021.d.ts",
	"lib.es2021.full.d.ts",
	"lib.es2021.intl.d.ts",
	"lib.es2021.promise.d.ts",
	"lib.es2021.string.d.ts",
	"lib.es2021.weakref.d.ts",
	"lib.es2022.array.d.ts",
	"lib.es2022.d.ts",
	"lib.es2022.error.d.ts",
	"lib.es2022.full.d.ts",
	"lib.es2022.intl.d.ts",
	"lib.es2022.object.d.ts",
	"lib.es2022.regexp.d.ts",
	"lib.es2022.string.d.ts",
	"lib.es2023.array.d.ts",
	"lib.es2023.collection.d.ts",
	"lib.es2023.d.ts",
	"lib.es2023.full.d.ts",
	"lib.es2023.intl.d.ts",
	"lib.es2024.arraybuffer.d.ts",
	"lib.es2024.collection.d.ts",
	"lib.es2024.d.ts",
	"lib.es2024.full.d.ts",
	"lib.es2024.object.d.ts",
	"lib.es2024.promise.d.ts",
	"lib.es2024.regexp.d.ts",
	"lib.es2024.sharedmemory.d.ts",
	"lib.es2024.string.d.ts",
	"lib.es5.d.ts",
	"lib.es6.d.ts",
	"lib.esnext.array.d.ts",
	"lib.esnext.collection.d.ts",
	"lib.esnext.d.ts",
	"lib.esnext.decorators.d.ts",
	"lib.esnext.disposable.d.ts",
	"lib.esnext.full.d.ts",
	"lib.esnext.intl.d.ts",
	"lib.esnext.iterator.d.ts",
	"lib.scripthost.d.ts",
	"lib.webworker.asynciterable.d.ts",
	"lib.webworker.d.ts",
	"lib.webworker.importscripts.d.ts",
	"lib.webworker.iterable.d.ts",
}

LibNames is the list of all bundled lib files, sorted by name. For the list of libs sorted by load order, use [tsoptions.Libs].

Functions

func LibPath

func LibPath() string

LibPath returns the path to the directory containing the bundled lib.d.ts files. If embedding is not enabled, this is a path on disk, and must be accessed through a real OS filesystem.

func TestingLibPath

func TestingLibPath() string

TestingLibPath returns the path to the source bundled libs directory. It's only valid to use in tests where the source code is available.

func WrapFS

func WrapFS(fs vfs.FS) vfs.FS

WrapFS returns an FS which redirects embedded paths to the embedded file system. If the embedded file system is not available, it returns the original FS.