@wider/utils_where-am-i/README.md

Determine where your code is running

# @wider/utils_where-am-i YDR Utilities - Where am I?

## Introduction

Disclose where your code is running

A javascript tool that investigates and reports on the environment in which it is running.  Presently coded for nodejs, browsers and various windows environments such as WScript or ASPclassic.  It will report "unknown" for environments that the author does not have access tp test.

There are no dependencies.

## Documentation

[Full Documentation](https://ydr-co.uk/packages/@wider/utils_where-am-i/index.html)

## Install

```command
npm install "@wider/utils_where-am-i"
```

## Use

```javascript
// from ES MOdule
import { genre, os, engine, version, _genres } from "@wider/utils_where-am-i/index.js";

// from commonJS  module
const  { genre, os, engine, version, _genres } = require ("@wider/utils_where-am-i");

// from non-module environments 
yourLinkOrImportMethod("a/path/to/@wider/utils_where-am-i/index.js)
var where = whereAmI();
```

The code in this package has been written deliberately in an early dialect of javascript so that identical code can run on legacy environments by just loading the file `./index.js` which then exposes the `whereAmI()` method.  This generates a simple object with the same properties that are exported in the node environment.

See the [Example](./tutorial-Examples.html) for the earliest versions of supported environments.

## Documentation and Example Results

On [npm](https://www.npmjs.com/package/@wider/utils_where-am-i), you can run this in **RunKit** and see the details for the linux server that runs npm.  Typically that will return

```javascript
{
    _genres: /unknown|server|browser|script/,
    genre: "server",
    engine: "node",
    version: "v14.17.4",
    computerName: "YDR-HP-2015"
    os: "linux"
}
```

Developer documentation and examples are available at [the @wider website](http://y-d-r.co.uk/packages/@wider/utils_where-am-i/index.html)