# bwindow

> Browser window accessor

Latest version **2.0.3** (published 2019-03-24) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.3 |
| Published | 2019-03-24 |
| First published | 2016-07-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=7.6 |
| Dependencies | 0 |
| Unpacked size | 24.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |

## Links

- npm: https://www.npmjs.com/package/bwindow
- Repository: https://github.com/b-labo/bwindow
- Homepage: https://github.com/b-labo/bwindow#readme
- Issues: https://github.com/b-labo/bwindow/issues
- npm.io page: https://npm.io/package/bwindow

## Recent versions

- 2.0.3 (latest) — 2019-03-24
- 2.0.2 — 2018-08-13
- 2.0.1 — 2018-08-12
- 2.0.0 — 2018-08-09
- 1.1.1 — 2018-04-10
- 1.1.0 — 2017-11-05
- 1.0.7 — 2016-08-09
- 1.0.6 — 2016-07-27
- 1.0.5 — 2016-07-25
- 1.0.4 — 2016-07-22
- 1.0.3 — 2016-07-22
- 1.0.2 — 2016-07-22
- 1.0.1 — 2016-07-20
- 1.0.0 — 2016-07-20

## README

bwindow
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/b-labo/bwindow
[bd_travis_url]: http://travis-ci.org/b-labo/bwindow
[bd_travis_shield_url]: http://img.shields.io/travis/b-labo/bwindow.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/b-labo/bwindow
[bd_travis_com_shield_url]: https://api.travis-ci.com/b-labo/bwindow.svg?token=
[bd_license_url]: https://github.com/b-labo/bwindow/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/b-labo/bwindow
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/b-labo/bwindow.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/b-labo/bwindow.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/b-labo/bwindow
[bd_gemnasium_shield_url]: https://gemnasium.com/b-labo/bwindow.svg
[bd_npm_url]: http://www.npmjs.org/package/bwindow
[bd_npm_shield_url]: http://img.shields.io/npm/v/bwindow.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Browser window accessor

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install bwindow --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

```javascript
'use strict'

const { get } = require('bwindow')

// Check document object available
{
  let isServerSide = !get('document')
  /* ... */
}

// With strict options, throws an error when not found
{
  let URL = get('URL', { strict: true })
  /* ... */
}

```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Functions.md.hbs" Start -->

<a name="section-doc-guides-03-functions-md"></a>

Functions
---------

Available functions

| Signature | Description |
| ---- | ----------- |
| `get(name, options, options.strict) -> ?Object` | Get object from window |
| `once(event, handler) -> function` | Bind window event once |
| `set(name, value, options, options.strict) -> ?Object` | Set object to window |


<!-- Section from "doc/guides/03.Functions.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/b-labo/bwindow/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [b-labo][b_labo_url]

[b_labo_url]: https://github.com/b-labo

<!-- Links End -->

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