# @dcl/posix

> Decentraland JS Portable Interface

Latest version **1.0.4** (published 2022-01-19) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @dcl/posix
pnpm add @dcl/posix
yarn add @dcl/posix
bun add @dcl/posix
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2022-01-19 |
| First published | 2021-05-29 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 119.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | decentralandbot |

## Links

- npm: https://www.npmjs.com/package/@dcl/posix
- Repository: https://github.com/decentraland/posix
- Homepage: https://github.com/decentraland/posix#readme
- Issues: https://github.com/decentraland/posix/issues
- npm.io page: https://npm.io/package/@dcl/posix

## Recent versions

- 1.0.4 (latest) — 2022-01-19
- 1.0.4-20220111144532.commit-f90a5d3 (next) — 2022-01-11
- 1.0.4-20211224173438.commit-5a9fc94 — 2021-12-24
- 1.0.4-20211222135529.commit-43a9e3d — 2021-12-22
- 1.0.4-20211222134830.commit-adaf222 — 2021-12-22
- 1.0.4-20211220185734.commit-366afb4 — 2021-12-20
- 1.0.3 — 2021-12-02
- 1.0.3-20211123171510.commit-fd24eb2 — 2021-11-23
- 1.0.3-20211119173339.commit-c94b391 — 2021-11-19
- 1.0.3-20211118190143.commit-0989fa3 — 2021-11-18
- 1.0.3-20211108141117.commit-fb3dffe — 2021-11-08
- 1.0.2 — 2021-10-20
- 1.0.2-20211019122352.commit-56ea49a — 2021-10-19
- 1.0.2-20211019115316.commit-a08a2f8 — 2021-10-19
- 1.0.1 — 2021-09-21
- … 8 more at https://npm.io/package/@dcl/posix/versions

## README

# @dcl/posix

Contains the environment type definitions for the exposed functions in the scenes. For that reason, this repository may be the most important part of the Decentraland's JS SDK.

## Why is it important?

**To ensure backwards compatibility**: according to its vision, Decentraland is a project that should be designed to last forever. That may be very difficult or even impractical, with this interface, we can ensure that every piece of JS code runs in a backwards compatible enviroment.

**To enable multiple runtimes**: keeping the interface simple, help the developers to implement new runtimes without being tied to platform specific APIs, i.e: IndexedDB, `localStorage`, or the `process` variable in NodeJS. As an example, the runtime does not expose `setTimeout` which is not a standard API.

## Contributions

This repository is append only, more specifically, nothing can be changed or removed once a type declaration gets released with a version tag (excluding the `@next` releases).

That makes this project almost static, because every addition is a maintainability compromise that will last forever.

For exceptional cases, like API additions, it should be a very thoughtful process for the reasons mentioned above, and the proposed mechanism is to first draft the full scope of the solution in a PR explaining the reasons and evaluating other options.

The most common and least "dangerous" addition to this repository are events from the Renderer or the Runtime (see `IEvents`).

Please follow the naming convention for events, it was decided to not use the `on` prefix on events since it is redundant and confusing with observables and event emiters: `events.on("eventName")` is better than `events.on("onEventName")`.

Also notice that `enum` are not allowed in ambient declarations, since enums are also values in Typescript. Use union types instead.

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