diff --git a/README.md b/README.md index 18c17b0..a6cb39b 100644 --- a/README.md +++ b/README.md @@ -97,6 +97,15 @@ const filename = await resolveFile('README.md', { }) ``` +### `resolveLockFile` + +Find path to the lock file (`yarn.lock`, `package-lock.json`, `pnpm-lock.yaml`, `npm-shrinkwrap.json`) or throws an error. + +```js +import { resolveLockFile } from 'pkg-types' +const lockfile = await resolveFile('.') +``` + ## Types **Note:** In order to make types working, you need to install `typescript` as a devDependency.