ftp-reap

    0.0.6 • Public • Published

    ftp-reap

    NPM version Build status Test coverage Dependency Status License Downloads Gittip

    Delete files over ftp based on last modified date.

    Usage

    var Reaper = require('ftp-reap');
    var reaper = new Reaper();
     
    reaper.maxAge('2 weeks'); // delete files older then two weeks
     
    reaper.watch({
        host: 'my.awesome.bucket',
        user: 'user',
        password: 'password'
    });
     
    reaper
        .run()
        .then(function () {
            // do something good
        })
        .catch(function (err) {
            // do something with error
        });

    API

    Note: API intentionally are the same as that of the fs-reap.

    var reaper = new Reaper()

    var Reaper = require('ftp-reap');
    var reaper = new Reaper();

    reaper.watch(dir)

    A FTP connection to reap.

    For more details about possible connection properties, look at ftp#connect() API.

    reaper.watch({
        host: 'n.n.n.n',
        port: 42,
        path: '/path/to/my/files'
    });
    reaper.watch({
        host: 'other_host',
        port: 21,
        path: '/path/to/my/other/files'
    });
     
    // or
     
    reaper.watch(
        {
            host: 'n.n.n.n',
            port: 42,
            path: '/path/to/my/files'
        },
        {
            host: 'other_host',
            port: 21,
            path: '/path/to/my/other/files'
        }
    );

    reaper.maxAge(ms)

    Set the max age based on last modified time for deletion, defaulting to Infinity.

    You may use Integer to specify milliseconds, or human-readable string format like 3 days or 2 months. For more details look at ms API.

    reaper.run().then( => ).catch(err =>)

    Recursively iterate through directories and delete old files. Directories structure are safe. Folders and symlinks (UNIX systems only) are ignored.

    FTP connections runs in parallel, so you shouldn't see significant perfomance loss.

    LICENSE

    The MIT License (MIT)

    Copyright (c) 2015 Alexander Ulizko alexander@ulizko.com

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Install

    npm i ftp-reap

    DownloadsWeekly Downloads

    2

    Version

    0.0.6

    License

    MIT

    Last publish

    Collaborators

    • avatar