# dropboxify

> Read directory content from dropbox with file attributes

Latest version **3.0.3** (published 2024-08-16) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.3 |
| Published | 2024-08-16 |
| First published | 2018-02-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=18 |
| Dependencies | 7 |
| Unpacked size | 9.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | coderaiser |
| Keywords | dropbox, directory, read, readdir, readify, cloudcmd |

## Links

- npm: https://www.npmjs.com/package/dropboxify
- Repository: https://github.com/coderaiser/dropboxify
- Homepage: http://github.com/coderaiser/dropboxify
- Issues: https://github.com/coderaiser/dropboxify/issues
- npm.io page: https://npm.io/package/dropboxify

## Dependencies (7)

- [currify](https://npm.io/package/currify.md) ^4.0.0
- [dropbox](https://npm.io/package/dropbox.md) ^10.34.0
- [date-fns](https://npm.io/package/date-fns.md) ^3.5.0
- [format-io](https://npm.io/package/format-io.md) ^2.0.0
- [shortdate](https://npm.io/package/shortdate.md) ^2.0.0
- [@cloudcmd/sortify](https://npm.io/package/@cloudcmd/sortify.md) ^2.0.0
- [@cloudcmd/formatify](https://npm.io/package/@cloudcmd/formatify.md) ^2.0.1

## Alternatives

- [csv-to-markdown-table](https://npm.io/package/csv-to-markdown-table.md) — 47.0K weekly downloads
- [@sapphire/ratelimits](https://npm.io/package/@sapphire/ratelimits.md) — 4.4K weekly downloads
- [js-csvparser](https://npm.io/package/js-csvparser.md) — 2.0K weekly downloads
- [@adadapted/js-sdk](https://npm.io/package/@adadapted/js-sdk.md) — 251 weekly downloads
- [@grapecity/spread-sheets-sparklines](https://npm.io/package/@grapecity/spread-sheets-sparklines.md) — 103 weekly downloads

## Recent versions

- 3.0.3 (latest) — 2024-08-16
- 3.0.2 — 2024-03-16
- 3.0.1 — 2024-03-16
- 3.0.0 — 2024-03-16
- 2.0.6 — 2020-07-03
- 2.0.5 — 2019-12-30
- 2.0.4 — 2019-10-11
- 2.0.3 — 2019-09-20
- 2.0.2 — 2018-11-05
- 2.0.1 — 2018-10-29
- 2.0.0 — 2018-10-29
- 1.0.5 — 2018-06-12
- 1.0.4 — 2018-03-05
- 1.0.3 — 2018-02-07
- 1.0.2 — 2018-02-02
- … 2 more at https://npm.io/package/dropboxify/versions

## README

# Dropboxify [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL] [![Coverage Status][CoverageIMGURL]][CoverageURL]

[NPMIMGURL]: https://img.shields.io/npm/v/dropboxify.svg?style=flat
[LicenseIMGURL]: https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat
[NPMURL]: https://npmjs.org/package/@coderaiser/dropboxify "npm"
[LicenseURL]: https://tldrlegal.com/license/mit-license "MIT License"
[BuildStatusURL]: https://github.com/coderaiser/dropboxify/actions?query=workflow%3A%22Node+CI%22 "Build Status"
[BuildStatusIMGURL]: https://github.com/coderaiser/dropboxify/workflows/Node%20CI/badge.svg

Read directory content from dropbox compatible way with [readify](https://github.com/coderaiser/readify).

## Install

```
npm i dropboxify
```

## API

### dropboxify(token, dir[, options])

- **token** - `string` generated [access token](https://blogs.dropbox.com/developers/2014/05/generate-an-access-token-for-your-own-account/)
- **options** - `object` can contain:
  - `sort` - sort by: name, size, date
  - `order` - "asc" or "desc" for ascending and descending order (default: "asc")
  - `type` - when "raw" returns not formatted result

## Examples

```js
const sort = 'size';
const order = 'desc';
const token = 'token';
const dir = '/';
const type = 'raw';

const files = await dropboxify(token, dir, {
    type,
    sort,
    order,
});

console.log(files);
// outputs
({
    path: '/',
    files: [{
        name: 'dropboxify.js',
        size: 4735,
        date: 1_377_248_899_000,
        owner: 0,
        mode: 0,
    }, {
        name: 'readify.js',
        size: 3735,
        date: 1_377_248_899_000,
        owner: 0,
        mode: 0,
    }],
});
```

## Related

- [Sortify](https://github.com/cloudcmd/sortify "Sortify") - sort directory content by name, size, date
- [Readify](https://github.com/coderaiser/readify "Readify") - read directory content with file attributes: size, date, owner, mode

## License

MIT

[CoverageURL]: https://coveralls.io/github/coderaiser/dropboxify?branch=master
[CoverageIMGURL]: https://coveralls.io/repos/coderaiser/dropboxify/badge.svg?branch=master&service=github

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