# @skyrim-platform/jcontainers

> TypeScript library for the JContainers Skyrim modding utility

Latest version **4.2.3** (published 2021-12-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @skyrim-platform/jcontainers
pnpm add @skyrim-platform/jcontainers
yarn add @skyrim-platform/jcontainers
bun add @skyrim-platform/jcontainers
```

## 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 | 4.2.3 |
| Published | 2021-12-23 |
| First published | 2021-12-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 167.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Maintainers | mrowrpurr |
| Keywords | skyrim, skyrim platform |

## Links

- npm: https://www.npmjs.com/package/@skyrim-platform/jcontainers
- Repository: https://github.com/skyrim-platform/jcontainers
- Issues: https://github.com/skyrim-platform/jcontainers/issues
- npm.io page: https://npm.io/package/@skyrim-platform/jcontainers

## Dependencies (1)

- [@skyrim-platform/skyrim-platform](https://npm.io/package/@skyrim-platform/skyrim-platform.md) ^2.3.1

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 4.2.3 (latest) — 2021-12-23
- 4.2.2 — 2021-12-23
- 4.2.1 — 2021-12-23
- 2.3.0 — 2021-12-23

## README

## `@skyrim-platform/jcontainers`

(Unofficial) TypeScript library for the JContainers Skyrim modding utility

- JContainers on GitHub: https://github.com/ryobg/JContainers
- JContainers on Nexus: https://www.nexusmods.com/skyrimspecialedition/mods/16495
- JContainers documentation: https://github.com/ryobg/JContainers/wiki

## Getting Started

You can find an example Skyrim Platform plugin with documentation on how to get started using this library: https://github.com/skyrim-platform/example-plugin-using-libraries

> Papyrus source code conversion to TypeScript originally generated using [Papyrus-2-Typescript](https://github.com/CarlosLeyvaAyala/Papyrus-2-Typescript)

## Example

```ts
import { once, Debug } from '@skyrim-platform/skyrim-platform'
import * as JMap from '@skyrim-platform/jcontainers/JMap'

// Store stuff in a JMap and then print it out
once('update', () => {
    const map = JMap.object()
    JMap.setStr(map, 'greeting', 'Hello, world!')
    Debug.messageBox(`JContainers says: ${JMap.getStr(map, 'greeting')}`)
})
```

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