# sideload

> Convert nested resources to "sideloaded" resources for consumption by frameworks (like Ember.js and jsonapi.org compatible frameworks)

Latest version **0.2.0** (published 2015-03-01) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2015-03-01 |
| First published | 2014-07-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Philip Allen |
| Maintainers | squirkle |
| Keywords | ember, json-api, sideload, nested |

## Links

- npm: https://www.npmjs.com/package/sideload
- Repository: https://github.com/squirkle/sideload
- Issues: https://github.com/squirkle/sideload/issues
- npm.io page: https://npm.io/package/sideload

## Dependencies (2)

- [dig-it](https://npm.io/package/dig-it.md) ^0.1.1
- [lodash](https://npm.io/package/lodash.md) ^2.4.1

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 0.2.0 (latest) — 2015-03-01
- 0.1.4 — 2014-08-19
- 0.1.3 — 2014-07-31
- 0.1.2 — 2014-07-31
- 0.1.1 — 2014-07-31
- 0.1.0 — 2014-07-31
- 0.0.1 — 2014-07-30

## README

# sideload [![Build Status](https://travis-ci.org/squirkle/sideload.svg?branch=master)](https://travis-ci.org/squirkle/sideload)

Convert nested resources to "sideloaded" resources for consumption by frameworks (like Ember.js) where sideloaded resources are expected.

## Installation
```bash
npm install sideload
```

## Usage
```javascript
var sideload = require('sideload');

var data = {
  presidents: [{
    id: 0,
    name: "Theodore Roosevelt",
    dogs: [{
      id: 0,
      name: "Pete",
      breed: "Bull Terrier"
    }, {
      id: 1,
      name: "Rollo",
      breed: "Saint Bernard"
    }]
  }, {
    id: 1,
    name: "Barack Obama",
    dogs: [{
      id: 2,
      name: "Bo",
      breed: "Portuguese Water Dog"
    }]
  }]
};

var sideloadedData = sideload(data, 'presidents.dogs');
```

This outputs:

```JSON
{
  "presidents": [
    {
      "id": 0,
      "name": "Theodore Roosevelt",
      "dogs": [0, 1]
    },
    {
      "id": 1,
      "name": "Barack Obama",
      "dogs": [2]
    }
  ],
  "dogs": [
    {
      "id": 0,
      "name": "Pete",
      "breed": "Bull Terrier"
    },
    {
      "id": 1,
      "name": "Rollo",
      "breed": "Saint Bernard"
    },
    {
      "id": 2,
      "name": "Bo",
      "breed": "Portuguese Water Dog"
    }
  ]
}
```

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