@stdlib/symbol-ctor/docs/types/index.d.ts

Symbols.

/*
* @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.
*/

// TypeScript Version: 4.1

// EXPORTS //

/**
* Returns a symbol.
*
* ## Notes
*
* -   Unlike conventional constructors, this function does **not** support the `new` keyword.
* -   This function is only supported in environments which support symbols.
*
* @param description - symbol description which can be used for debugging but not to access the symbol itself
* @returns symbol
*/
export = Symbol;