time-to-botec/squiggle/node_modules/@stdlib/fs/resolve-parent-path-by/lib/index.js

68 lines
1.6 KiB
JavaScript
Raw Normal View History

/**
* @license Apache-2.0
*
* Copyright (c) 2021 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
'use strict';
/**
* Resolve a path according to a predicate function by walking parent directories.
*
* @module @stdlib/fs/resolve-parent-path-by
*
* @example
* var resolveParentPathBy = require( '@stdlib/fs/resolve-parent-path-by' );
*
* resolveParentPathBy( 'package.json', predicate, onPath );
*
* function predicate( path, next ) {
* next( null, true );
* }
*
* function onPath( error, path ) {
* if ( error ) {
* throw error;
* }
* console.log( path );
* }
*
* @example
* var resolveParentPathBy = require( '@stdlib/fs/resolve-parent-path-by' );
*
* function predicate() {
* return true;
* }
*
* var path = resolveParentPathBy.sync( 'package.json', predicate );
* // e.g., returns '...'
*/
// MODULES //
var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
var resolveParentPathBy = require( './async.js' );
var sync = require( './sync.js' );
// MAIN //
setReadOnly( resolveParentPathBy, 'sync', sync );
// EXPORTS //
module.exports = resolveParentPathBy;