sp

svn-polling

🕓 A SVN Log Polling mechanism for NodeJS

Showing:

Popularity

Downloads/wk

0

GitHub Stars

2

Maintenance

Last Commit

5yrs ago

Contributors

0

Package

Dependencies

4

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

svn-polling

npm npm

🕓 A SVN Log Polling mechanism for NodeJS.

Install

$ npm install --save svn-polling

or

$ yarn add svn-polling

Requirements

You need to have the svn command installed.

Usage

const SvnPolling = require('svn-polling');

const polling = new SvnPolling({
    remoteUrl: 'svn://your-svn-project-url.com/code/trunk'
});

// Will be called as soon as new changes are commited into the repository
polling.on('data', (data) => {
    console.log(data);
});

// Start polling from svn log history
polling.start();

Result:

{
  "revision": 2,
  "logs": [
    {
      "revision": "1",
      "author": "marcobarcelos",
      "date": "2017-01-05T03:29:42.036677Z",
      "msg": "Add index.js",
      "changes": [
        {
          "action": "A",
          "path": "/index.js"
        }
      ]
    },
    {
      "revision": "2",
      "author": "marcobarcelos",
      "date": "2017-01-05T03:30:20.881618Z",
      "msg": "Add readme.md",
      "changes": [
        {
          "action": "A",
          "path": "/readme.md"
        }
      ]
    }
  ]
}

Config

You can configure some options by passing it into the constructor:

const options = {
    remoteUrl: 'svn://your-svn-project-url.com/code/trunk',
    pollInterval: 1000,
    logsLimit: 10,
  username: 'marcobarcelos',
  password: 'ultrasecret'
};

const polling = new SvnPolling(options);

remoteUrl

Type: string

The remote repository's url.

pollInterval

Type: number
Default: 15000

The interval between a svn log history fetch and another.

logsLimit

Type: number
Default: 5

How many logs/commits to retrieve by the first time.

username

Type: string
Optional (in case authentication is not required or is already saved)

The svn user's username.

password

Type: string
Optional (in case authentication is not required or is already saved)

The svn user's password.

License

MIT © Marco Barcelos

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial