An open API service indexing awesome lists of open source software.

https://github.com/pigeonposse/structium

Serialize and deserialize any data structure in any environment
https://github.com/pigeonposse/structium

browser deserialize devs files format javascript library node pigeonposse pp serialize typescript

Last synced: 6 months ago
JSON representation

Serialize and deserialize any data structure in any environment

Awesome Lists containing this project

README

          

# Structium

[![Web](https://img.shields.io/badge/Web-grey?style=for-the-badge&logoColor=white)](https://pigeonposse.com)
[![About Us](https://img.shields.io/badge/About%20Us-grey?style=for-the-badge&logoColor=white)](https://pigeonposse.com?popup=about)
[![Donate](https://img.shields.io/badge/Donate-pink?style=for-the-badge&logoColor=white)](https://pigeonposse.com/?popup=donate)
[![Twitter](https://img.shields.io/badge/Twitter-black?style=for-the-badge&logoColor=white&logo=twitter)](https://twitter.com/pigeonposse_)
[![Instagram](https://img.shields.io/badge/Instagram-black?style=for-the-badge&logoColor=white&logo=instagram)](https://www.instagram.com/pigeon.posse/)
[![Medium](https://img.shields.io/badge/Medium-black?style=for-the-badge&logoColor=white&logo=medium)](https://medium.com/@pigeonposse)

[![BANNER](https://github.com/pigeonposse/structium/blob/main/docs/public/banner.png?raw=true)](https://structium.pigeonposse.com/guide/core)

[![License](https://img.shields.io/github/license/pigeonposse/structium?style=for-the-badge&color=green&logoColor=white)](/LICENSE)
[![Version](https://img.shields.io/npm/v/structium?style=for-the-badge&color=blue&label=Version)](https://www.npmjs.com/package/structium)
[![NPM package minimized gzipped size](https://img.shields.io/bundlejs/size/structium?style=for-the-badge&color=orange&label=Minimized+size&logoColor=white)](https://www.npmjs.com/package/structium)
[![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/structium/0.0.3?style=for-the-badge&color=orange&logoColor=white)](https://www.npmjs.com/package/structium)

Serialize and deserialize any data structure

## Table of contents

- [What is it `structium`?](#what-is-it-structium)
- [Usage](#usage)
- [Libary usage](#libary-usage)
- [Individual usage](#individual-usage)
- [CLI usage](#cli-usage)
- [🔑 Installation](#-installation)
- [➕ More](#-more)
- [👨‍💻 Development](#-development)
- [❤️ Donate](#-donate)
- [📜 License](#-license)
- [✨ About us](#-about-us)

## What is it `structium`?

![BANNER](https://github.com/pigeonposse/structium/blob/main/docs/public/banner.png?raw=true)

`structium` is a JavaScript Library for Serialize and deserialize any data structure in any environment (browser, node, etc).

[Read more](https://www.npmjs.com/package/structium)

## Usage

### Libary usage

```js
import { markdown } from 'structium'

const data = markdown.deserialize(`
# Example Markdown

This is an example Markdown document.
[Read more](https://structium.pigeonposse.com)`
)

console.log(data)

```

### Individual usage

```js
import { deserialize } from '@structium/toml'

const data = deserialize(`
name = "Alice"
age = 30
city = "New York"

[address]
street = "123 Main St"
zip = "10001"

hobbies = ["reading", "hiking", "painting"]
`)
console.log(data)

```

### CLI usage

```bash
npx structium yaml deserialize -i https://example.com/data.yaml -o data.json
```

## 🔑 Installation

```bash
npm install structium
# or
pnpm install structium
# or
yarn add structium
# or
bun add structium
# or
deno add structium
```

## ➕ More

- 🌞 [Core](https://structium.pigeonposse.com/guide/core)
- [Aio](https://structium.pigeonposse.com/guide/aio)
- [Asn1](https://structium.pigeonposse.com/guide/asn1)
- [Cson](https://structium.pigeonposse.com/guide/cson)
- [Css](https://structium.pigeonposse.com/guide/css)
- [Csv](https://structium.pigeonposse.com/guide/csv)
- [Env](https://structium.pigeonposse.com/guide/env)
- [Hcl](https://structium.pigeonposse.com/guide/hcl)
- [Graphql](https://structium.pigeonposse.com/guide/graphql)
- [Html-markdown](https://structium.pigeonposse.com/guide/html-markdown)
- [Ini](https://structium.pigeonposse.com/guide/ini)
- [Javascript](https://structium.pigeonposse.com/guide/javascript)
- [Json](https://structium.pigeonposse.com/guide/json)
- [Jsonld](https://structium.pigeonposse.com/guide/jsonld)
- [Lua](https://structium.pigeonposse.com/guide/lua)
- [Plist](https://structium.pigeonposse.com/guide/plist)
- [Sql](https://structium.pigeonposse.com/guide/sql)
- [Svg](https://structium.pigeonposse.com/guide/svg)
- [Toml](https://structium.pigeonposse.com/guide/toml)
- [Typescript](https://structium.pigeonposse.com/guide/typescript)
- [Xml](https://structium.pigeonposse.com/guide/xml)
- [Yaml](https://structium.pigeonposse.com/guide/yaml)

---

## 👨‍💻 Development

__structium__ is an open-source project and its development is open to anyone who wants to participate.

[![Issues](https://img.shields.io/badge/Issues-grey?style=for-the-badge)](https://github.com/pigeonposse/structium/issues)
[![Pull requests](https://img.shields.io/badge/Pulls-grey?style=for-the-badge)](https://github.com/pigeonposse/structium/pulls)
[![Read more](https://img.shields.io/badge/Read%20more-grey?style=for-the-badge)](https://structium.pigeonposse.com)

## ❤️ Donate

Help us to develop more interesting things.

[![Donate](https://img.shields.io/badge/Donate-grey?style=for-the-badge)](https://pigeonposse.com/?popup=donate)

## 📜 License

This software is licensed with __[MIT]({{const.pkg.extra.licenseURL}})__.

[![Read more](https://img.shields.io/badge/Read-more-grey?style=for-the-badge)]({{const.pkg.extra.licenseURL}})

## ✨ About us

*PigeonPosse* is a __code development collective__ focused on creating practical and interesting tools that help developers and users enjoy a more agile and comfortable experience. Our projects cover various programming sectors and we do not have a thematic limitation in terms of projects.

[![More](https://img.shields.io/badge/Read-more-grey?style=for-the-badge)](https://github.com/pigeonposse)

## Contributors

| | Name | Role |
| ----- | ---- | ---- |
| ![Angelo](https://github.com/angelespejo.png?size=72) | [Angelo](https://github.com/angelespejo) | 👑 Author |
| ![PigeonPosse](https://github.com/pigeonposse.png?size=72) | [PigeonPosse](https://github.com/pigeonposse) | 🏢 Organization |

---

[![Web](https://img.shields.io/badge/Web-grey?style=for-the-badge&logoColor=white)](https://pigeonposse.com)
[![About Us](https://img.shields.io/badge/About%20Us-grey?style=for-the-badge&logoColor=white)](https://pigeonposse.com?popup=about)
[![Donate](https://img.shields.io/badge/Donate-pink?style=for-the-badge&logoColor=white)](https://pigeonposse.com/?popup=donate)
[![Twitter](https://img.shields.io/badge/Twitter-black?style=for-the-badge&logoColor=white&logo=twitter)](https://twitter.com/pigeonposse_)
[![Instagram](https://img.shields.io/badge/Instagram-black?style=for-the-badge&logoColor=white&logo=instagram)](https://www.instagram.com/pigeon.posse/)
[![Medium](https://img.shields.io/badge/Medium-black?style=for-the-badge&logoColor=white&logo=medium)](https://medium.com/@pigeonposse)