# picklefriend

> Typescript package compatible with python's pickle loads/dumps

Latest version **1.0.8** (published 2022-06-17) · Apache-2.0 license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.8 |
| Published | 2022-06-17 |
| First published | 2022-06-13 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 19.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | joaopfg |
| Maintainers | joaopfg |
| Keywords | pickle, typescript, python |

## Links

- npm: https://www.npmjs.com/package/picklefriend
- Repository: https://github.com/joaopfg/picklefriend
- Homepage: https://github.com/joaopfg/picklefriend#readme
- Issues: https://github.com/joaopfg/picklefriend/issues
- npm.io page: https://npm.io/package/picklefriend

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.0.8 (latest) — 2022-06-17
- 1.0.7 — 2022-06-13
- 1.0.6 — 2022-06-13
- 1.0.5 — 2022-06-13
- 1.0.4 — 2022-06-13
- 1.0.3 — 2022-06-13
- 1.0.2 — 2022-06-13
- 1.0.1 — 2022-06-13
- 1.0.0 — 2022-06-13

## README

# picklefriend

[![npm version](https://img.shields.io/npm/v/picklefriend.svg?style=flat-square)](https://www.npmjs.com/package/picklefriend)
[![build](https://img.shields.io/github/workflow/status/joaopfg/picklefriend/Node.js%20CI?style=flat-square&label=build)](https://github.com/joaopfg/picklefriend/actions)
[![github](https://flat.badgen.net/badge/icon/github?icon=github&label)](https://github.com/joaopfg/picklefriend/)
[![sponsors](https://img.shields.io/github/sponsors/joaopfg?style=flat-square&color=1da1f2)](https://github.com/sponsors/joaopfg/)

Typescript package compatible with python's pickle loads/dumps

# Installation
```bash
npm i picklefriend
```

# Usage
```typescript
import { pickle } from 'picklefriend'

let myString = "my test string";
let myStringDumped = pickle.dumps(myString);
let myStringLoaded = pickle.loads(myStringDumped);

console.log(myStringLoaded);
```

# Development
### Fork the main branch, clone it and entry in the root folder
```bash
git clone git@github.com:joaopfg/picklefriend.git
cd picklefriend
```
### Install the dependencies
```bash
npm install
```
### Generate the dist folder
```bash
tsc
```
### Unit tests
The unit tests are located in the `test` folder. If you want to create new tests, they must go inside this folder and the test script must be updated in `package.json`.
```bash
npm test
```

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