index.js (1106B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 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 * Return a directory for user-specific configuration files. 23 * 24 * @module @stdlib/os/configdir 25 * 26 * @example 27 * var configdir = require( '@stdlib/os/configdir' ); 28 * 29 * var dir = configdir(); 30 * // e.g., returns '/Users/<username>/Library/Preferences' 31 * 32 * dir = configdir( 'appname/config' ); 33 * // e.g., returns '/Users/<username>/Library/Preferences/appname/config' 34 */ 35 36 // MODULES // 37 38 var configdir = require( './configdir.js' ); 39 40 41 // EXPORTS // 42 43 module.exports = configdir;