Bun.BunLockFile TypeScript type alias | API Reference | Bun

Bun.BunLockFile TypeScript type alias | API Reference | BunBuildDocsReferenceGuidesBlogDiscord/Bun/BunLockFilePcatalogPcatalogsPconfigVersionPlockfileVersionPoverridesPpackagesPpatchedDependenciesPtrustedDependenciesPworkspaces

Search the reference...

/

BuildDocsReferenceGuidesBlogDiscord/Bun/BunLockFilePcatalogPcatalogsPconfigVersionPlockfileVersionPoverridesPpackagesPpatchedDependenciesPtrustedDependenciesPworkspaces

type

BunLockFiletype BunLockFile = catalog?: Recordstring, string>

catalogs?: Recordstring, Recordstring, string>>

configVersion?: 0 | 1

0 / undefined for projects created before v1.3.2, 1 for projects created after.

Right now this only changes the default install linker strategy:

With 0, the linker is hoisted.With 1, the linker is isolated for workspaces and hoisted for single-package projects.

lockfileVersion: 0 | 1overrides?: Recordstring, string>

[ "name@version", registry (TODO: remove if default), INFO, integrity] symlink -> [ "name@link:path", INFO ] folder -> [ "name@file:path", INFO ] workspace -> [ "name@workspace:path" ] // workspace is only path tarball -> [ "name@tarball", INFO ] root -> [ "name@root:", { bin, binDir } ] git -> [ "name@git+repo", INFO, .bun-tag string (TODO: remove this) ] github -> [ "name@github:user/repo", INFO, .bun-tag string (TODO: remove this) ] ```" data-algolia-static="false" data-algolia-merged="false" data-type="Property">packages: { __index[pkg: string]: BunLockFilePackageArray; }

INFO = { prod/dev/optional/peer dependencies, os, cpu, libc (TODO), bin, binDir }

// first index is resolution for each type of package
npm -> [ "name@version", registry (TODO: remove if default), INFO, integrity]
symlink -> [ "name@link:path", INFO ]
folder -> [ "name@file:path", INFO ]
workspace -> [ "name@workspace:path" ] // workspace is only path
tarball -> [ "name@tarball", INFO ]
root -> [ "name@root:", { bin, binDir } ]
git -> [ "name@git+repo", INFO, .bun-tag string (TODO: remove this) ]
github -> [ "name@github:user/repo", INFO, .bun-tag string (TODO: remove this) ]

patchedDependencies?: Recordstring, string>

trustedDependencies?: string[]

workspaces: { __index[workspace: string]: BunLockFileWorkspacePackage; }

Types for bun.lock

Resources

ReferenceDocsGuidesDiscordMerch StoreGitHubBlog 

Toolkit

RuntimePackage managerTest runnerBundlerPackage runner

Project

Bun 1.0Bun 1.1Bun 1.2Bun 1.3RoadmapContributingLicense

Baked with ❤️ in San Francisco

We're hiring →