# yalookup

> yet another lookup

Latest version **0.1.4** (published 2015-10-22) · SEE LICENSE IN ./LICENSE license · 0 weekly downloads

## Install

```sh
npm install yalookup
pnpm add yalookup
yarn add yalookup
bun add yalookup
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2015-10-22 |
| First published | 2015-10-21 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN ./LICENSE |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | bzb-stcnx |
| Maintainers | bzb-stcnx |
| Keywords | recursive, find, look-up, file |

## Links

- npm: https://www.npmjs.com/package/yalookup
- Repository: https://github.com/bzb-stcnx/yalookup
- Homepage: https://github.com/bzb-stcnx/compliance#readme
- Issues: https://github.com/bzb-stcnx/compliance/issues
- npm.io page: https://npm.io/package/yalookup

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 0.1.4 (latest) — 2015-10-22
- 0.1.3 — 2015-10-22
- 0.1.2 — 2015-10-21
- 0.1.1 — 2015-10-21
- 0.1.0 — 2015-10-21
- 0.0.1 — 2015-10-21
- 0.0.0 — 2015-10-21

## README

# yalookup
[![NPM](https://nodei.co/npm/yalookup.png?compact=true)](https://nodei.co/npm/yalookup/)
[![build status](https://secure.travis-ci.org/bzb-stcnx/yalookup.png)](http://travis-ci.org/bzb-stcnx/yalookup)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)

yet another lookup!
look for a file searching from the current or a given directory up.

# motivation
very lean recursive implementation restricted to using only node's core modules.
* no glob
* only one option (cwd)
* only synchronous
* no cli

at least for now.

# usage
## example
search from `__dirname` upwards for `package.json`:
```javascript
var lookup = require('yalookup')
var filepath = lookup('package.json', { cwd: __dirname })
```

## signature
**lookup(filename: `string`, options: `object`): `string`**
* **filename** `string` plain text name of the file, no support for glob
* **options** `object` currently only supports a single option:
  * **cwd** `string` the directory to start searching upwards from,
  defaults to `process.cwd()`
* **return** `string` the filepath of the file if found, `null` otherwise

# status
[![stable](http://badges.github.io/stability-badges/dist/stable.svg)](http://github.com/badges/stability-badges)

# license
(C) Copyright 2015, bzb-stcnx,
all rights reserved.
[MIT](./LICENSE)

---
_Source: https://npm.io/package/yalookup · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._