Installations

npm install rollback

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=8

Node Version

10.20.1

NPM Version

6.14.4 Pull Requests

Open

21

Total

171

Closed

26

Merged

124

Issues

Open

3

Total

14

Closed

11

Releases

3

v0.2.0

Published on 22 Mar 2019

v0.1.1

Published on 12 Mar 2019

v0.1.0

Published on 10 Mar 2019

View all 3 releases

Contributors

2

Unable to fetch Contributors

View all 2 contributors

Languages

2

TypeScript

JavaScript

TypeScript (97.39%)

JavaScript (2.61%)

Developer

JustinLivi

Download Statistics

Total Downloads

5,468

Last Day

1

Last Week

3

Last Month

15

Last Year

544

GitHub Statistics

4 Stars

370 Commits

1 Forks

3 Watching

26 Branches

2 Contributors

Bundle Size

81.58 kB

Minified

25.28 kB

Minified + Gzipped

Bundlephobia

Maintainers

1

Package Meta Information

Latest Version

0.2.16

Package Id

rollback@0.2.16

Unpacked Size

77.37 kB

Size

17.47 kB

File Count

26

NPM Version

6.14.4

Node Version

10.20.1

Total Downloads

Cumulative downloads

Total Downloads

5,468

Last day

0%

1

Compared to previous day

Last week

-50%

3

Compared to previous week

Last month

-59.5%

15

Compared to previous month

Last year

-17.1%

544

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

6

@types/fs-extra @types/node @types/tmp fs-extra graceful-fs tmp-promise

Dev Dependencies

17

@types/jest @types/mock-fs conventional-changelog-cli conventional-changelog-eslint conventional-recommended-bump coveralls jest jest-extended mock-fs prettier ts-jest tslint tslint-config-prettier tslint-eslint-rules typedoc typedoc-plugin-markdown typescript

Versions

Rollback

Rollback the rock!

Undo pesky file system mutations with ease.

Installation

npm i -s rollback

Both typescript and javascript support come out of the box.

Basic Usage

Asynchronous API

Take a snapshot of a directory.

1import { snapshot } from 'rollback';
2import { writeFileSync } from 'fs';
3
4snapshot({
5  path: '/some/directory'
6}).then(snap => {
7  // make some changes
8  writeFileSync('/some/directory/myFile', 'some updates');
9  // then rollback all the changes
10  return snap.rollback();
11});

Take a snapshot of a file.

1import { snapshotFile } from 'rollback';
2import { writeFileSync } from 'fs';
3
4snapshotFile({
5  path: '/some/file.txt'
6}).then(snap => {
7  // make some changes
8  writeFileSync('/some/file.txt', 'some updates');
9  // then rollback all the changes
10  return snap.rollback();
11});

Synchronous API

Take a snapshot of a directory.

1import { snapshotSync } from 'rollback';
2import { writeFileSync } from 'fs';
3
4const snap = snapshotSync({
5  path: '/some/directory'
6});
7writeFileSync('/some/directory/myFile', 'some updates');
8snap.rollbackSync();

Take a snapshot of a file.

1import { snapshotFileSync } from 'rollback';
2import { writeFileSync } from 'fs';
3
4const snap = snapshotFileSync({
5  path: '/some/file.txt'
6});
7writeFileSync('/some/file.txt', 'some updates');
8snap.rollbackSync();

Advanced Usage

Rollback exposes four base methods: snapshot, snapshotSync, snapshotFile, and snapshotFileSync.

All methods accept all configuration options exposed by tmp.

Additionally the following options from fs-extra's copy are supported:

preserveTimestamps, filter, recursive (recursive is only supported for snapshot and snapshotSync)

snapshot and snapshotFile return a Promise which resolves with a Snapshot object.

snapshotSync and snapshotFileSync return a Snapshot directly.

Snapshot

A Snapshot object has the following properties:

property	type	description
`path`	`string`	the path of the temporary directory
`cleanup`	`() => void`	manually cleans up the temporary directory
`rollback`	`(options?: RollbackOptions) => Promise<void>`	asynchronously rolls back any changes to the snapshot
`rollbackSync`	`(options?: RollbackOptions) => void`	synchronously rolls back any changes to the snapshot

RollbackOptions takes the following form:

1interface RollbackOptions {
2  preserveTimestamps?: boolean;
3  recursive?: boolean; // only supported if the snapshot is of a directory 
4}

The default for rollback options is whatever was specified in the snapshot, snapshotSync, snapshotFile, or snapshotFileSync invocation that generated the Snapshot object.

API Documentation

API

License

Licensed under MIT

No vulnerabilities found.

10

Security-Policy

Determines if the project has published a security policy.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

9

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.3

/10

Last Scanned on 2024-12-30

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

rollback

Installations

Developer Guide

No

CommonJS

>=8

10.20.1

6.14.4

Pull Requests

21

171

26

124

Issues

3

14

11

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

JustinLivi

Download Statistics

GitHub Statistics

Bundle Size

81.58 kB

25.28 kB

Maintainers

Package Meta Information

Total Downloads

5,468

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

Rollback

Installation

Basic Usage

Asynchronous API

Synchronous API

Advanced Usage

Snapshot

API Documentation

License

10

10

10

9

0

0

0

0

0

4.3

/10

Other packages similar to rollback