# gts-snapsync

> An excellent library and toolset for optimized transfers of single files and directory snapshots based on librsync.

Latest version **1.2.3** (published 2021-09-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install gts-snapsync
pnpm add gts-snapsync
yarn add gts-snapsync
bun add gts-snapsync
```

## 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 | 1.2.3 |
| Published | 2021-09-22 |
| First published | 2020-06-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 9.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 0 |
| Author | Niklas Salmoukas |
| Maintainers | gts-software |

## Links

- npm: https://www.npmjs.com/package/gts-snapsync
- Repository: https://github.com/gts-software/snapsync
- Homepage: https://github.com/gts-software/snapsync#readme
- Issues: https://github.com/gts-software/snapsync/issues
- npm.io page: https://npm.io/package/gts-snapsync

## Dependencies (2)

- [nan](https://npm.io/package/nan.md) ^2.15.0
- [@mapbox/node-pre-gyp](https://npm.io/package/@mapbox/node-pre-gyp.md) ^1.0.5

## Recent versions

- 1.2.3 (latest) — 2021-09-22
- 1.1.6 — 2020-06-05
- 1.1.3 — 2020-06-04

## README

# gts-snapsync

An excellent library and toolset for optimized transfers of single files and directory snapshots based on librsync.

![npm downloads total](https://img.shields.io/npm/dt/gts-snapsync.svg) ![npm version](https://img.shields.io/npm/v/gts-snapsync.svg) ![npm license](https://img.shields.io/npm/l/gts-snapsync.svg)


## Installation

Install the `gts-snapsync` module via

```sh
npm install gts-snapsync --save
```

or

```sh
yarn add gts-snapsync
```

See the original documentation at https://github.com/core-process/snapsync  
This fork added async features to all the functions of snapsync.
Just add a callback function as the last parameter, for example:

Sync:
```js
snapsync.snap.create('dir', 'file');
```
Async:
```js
snapsync.snap.create('dir', 'file', (error) => {
	if (error) { console.log(error) }
});
// or 
await snapsync.snap.asyncCreate('dir','file');
```

## Changelog
> #### v1.2.2
> - Added support for Node 12+
> - Dropped support for Node < 8
> - Added `custom_modules` containing a modified version of `node-pre-gyp-github` since the original does not work anymore.
> - Use latest version of `@octokit/rest` to work with Github API

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