https://github.com/dat-ecosystem-archive/hyperdrive-import-files

Import some files and folders into a hyperdrive [ DEPRECATED - More info on active projects and modules at https://dat-ecosystem.org/ ]
https://github.com/dat-ecosystem-archive/hyperdrive-import-files

Last synced: 10 days ago
JSON representation

Import some files and folders into a hyperdrive [ DEPRECATED - More info on active projects and modules at https://dat-ecosystem.org/ ]

• Host: GitHub
• URL: https://github.com/dat-ecosystem-archive/hyperdrive-import-files
• Owner: dat-ecosystem-archive
• Archived: true
• Created: 2016-06-29T15:22:15.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2021-12-28T21:04:43.000Z (almost 3 years ago)
• Last Synced: 2024-05-16T13:16:09.693Z (6 months ago)
• Language: JavaScript
• Homepage:
• Size: 90.8 KB
• Stars: 21
• Watchers: 2
• Forks: 10
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-dat - hyperdrive-import-files - import files and folders into a hyperdrive archive (Using Dat / File Imports & Exports)

README

        
[![deprecated](http://badges.github.io/stability-badges/dist/deprecated.svg)](https://dat-ecosystem.org/) 

More info on active projects and modules at [dat-ecosystem.org](https://dat-ecosystem.org/)  

---

# hyperdrive-import-files

Import the contents of a folder into a [hyperdrive](https://github.com/mafintosh/hyperdrive), and optionally keep watching for changes.

[![Build Status](https://travis-ci.org/juliangruber/hyperdrive-import-files.svg?branch=master)](https://travis-ci.org/juliangruber/hyperdrive-import-files)

## Example

```js

const hyperdrive = require('hyperdrive')

const memdb = require('memdb')

const hyperImport = require('hyperdrive-import-files')

const drive = hyperdrive(memdb())

const archive = drive.createArchive()

hyperImport(archive, 'a/directory/', err => {

  // ...

})

```

## Installation

```bash

$ npm install hyperdrive-import-files

```

## API

### hyperImport(archive, target, [, options][, cb])

Recursively import `target`, which is the path to a directory or file,  into `archive` and call `cb` with the potential error. The import happens sequentually. Returns a `status` object.

Options

- `watch`: watch files for changes & import on change (archive must be live)

- `overwrite`: allow files in the archive to be overwritten (defaults to true)

- `compareFileContent`: compare import-candidates to archive's internal copy. If false, will only compare mtime and file-size, which is faster but may reslt in false-positives. (defaults to false)

- `basePath`: where in the archive should the files import to? (defaults to '')

- `ignore`: [anymatch](https://npmjs.org/package/anymatch) expression to ignore files

- `dryRun`: step through the import, but don't write any files to the archive (defaults to false)

- `indexing`: Useful if `target === dest` so hyperdrive does not rewrite the files on import.

To enable watching, set `watch: true`, like this:

```js

const status = hyperImport(archive, target, { watch: true }, err => {

  console.log('initial import done')

})

status.on('error', err => {

  // ...

})

// when you want to quit:

status.close()

```

If you want to import into a subfolder, set `basePath`:

```js

hyperImport(archive, target, { basePath: '/some/subdir' }, err => {...})

```

### status

Events:

- `error` (`err`)

- `file imported` ({ `path`, `mode=updated|created` })

- `file skipped` ({ `path` })

- `file watch event` ({ `path`, `mode=updated|created` })

Properties:

- `fileCount`: The count of currently known files

- `totalSize`: Total file size in bytes

- `bytesImported`: Amount of bytes imported so far

## License

MIT