@stdlib/repl-help/docs/types/index.d.ts

Return help text associated with a provided alias.

/*
* @license Apache-2.0
*
* Copyright (c) 2019 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.
*/

// TypeScript Version: 4.1

/**
* Returns help text associated with a specified alias.
*
* @param alias - alias
* @returns help text
*
* @example
* var txt = help( 'base.sin' );
*/
declare function help( alias: string ): string | null;


// EXPORTS //

export = help;