chdir-promise

Change working dir and return a promise, a stack of folders is maintained to jump back

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
chdir-promise
0.6.25 years ago8 years agoMinified + gzip package size for chdir-promise in KB

Readme

chdir-promise
Change current working folder by returning a promise + a stack of folders to jump back

!NPMchdir-promise-icon chdir-promise-url
!Build statuschdir-promise-ci-image chdir-promise-ci-url !semantic-releasesemantic-image semantic-url
var chdir = require('chdir-promise');
// only has two methods: chdir.to and chdir.from (alias chdir.back)
chdir.to('foo/bar/folder')
    // do something inside foo/bar/folder
    .then(chdir.back) // or chdir.from
    .done();

if you need to return value before returning use .tap method
chdir.to('foo/bar/folder')
    .then(function () {
        return 'foo'; // value to return
    })
    .tap(chdir.back);
    // resolved with value 'foo'

Advice
Put chdir.back into .finally callback to make sure it is always executed, even if there is an exception.
chdir.to('foo/bar/folder')
    .then(function () {
        throw new Error('oh my');
    })
    .then(chdir.back) // not called!
    .finally(chdir.back); // called

nextTo

If you have several hops you can schedule next hop using chdir.nextTo which allows you to save extra empty function.
// second hop is deferred
chdir.to('first/folder')
    .then(chdir.back)
    .then(() => chdir.to('second/folder'))

// equivalent
chdir.to('first/folder')
    .then(chdir.back)
    .then(chdir.nextTo('second/folder'))

Implemented using bluebirdhttps://github.com/petkaantonov/bluebird, lazy-asslazy-ass and check-more-typescheck-more-types.

Small print

Author: Gleb Bahmutov © 2014

License: MIT - do anything with the code, but don't blame me if it does not work.
Spread the word: tweet, star on github, etc.
Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2014 Gleb Bahmutov
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.