time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

index.js (1649B)

      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2021 The Stdlib Authors.
      5 *
      6 * Licensed under the Apache License, Version 2.0 (the "License");
      7 * you may not use this file except in compliance with the License.
      8 * You may obtain a copy of the License at
      9 *
     10 *    http://www.apache.org/licenses/LICENSE-2.0
     11 *
     12 * Unless required by applicable law or agreed to in writing, software
     13 * distributed under the License is distributed on an "AS IS" BASIS,
     14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     15 * See the License for the specific language governing permissions and
     16 * limitations under the License.
     17 */
     18 
     19 'use strict';
     20 
     21 /**
     22 * Resolve a path according to a predicate function by walking parent directories.
     23 *
     24 * @module @stdlib/fs/resolve-parent-path-by
     25 *
     26 * @example
     27 * var resolveParentPathBy = require( '@stdlib/fs/resolve-parent-path-by' );
     28 *
     29 * resolveParentPathBy( 'package.json', predicate, onPath );
     30 *
     31 * function predicate( path, next ) {
     32 *     next( null, true );
     33 * }
     34 *
     35 * function onPath( error, path ) {
     36 *     if ( error ) {
     37 *         throw error;
     38 *     }
     39 *     console.log( path );
     40 * }
     41 *
     42 * @example
     43 * var resolveParentPathBy = require( '@stdlib/fs/resolve-parent-path-by' );
     44 *
     45 * function predicate() {
     46 *     return true;
     47 * }
     48 *
     49 * var path = resolveParentPathBy.sync( 'package.json', predicate );
     50 * // e.g., returns '...'
     51 */
     52 
     53 // MODULES //
     54 
     55 var setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' );
     56 var resolveParentPathBy = require( './async.js' );
     57 var sync = require( './sync.js' );
     58 
     59 
     60 // MAIN //
     61 
     62 setReadOnly( resolveParentPathBy, 'sync', sync );
     63 
     64 
     65 // EXPORTS //
     66 
     67 module.exports = resolveParentPathBy;