Skip to content

Commit 05b6fa0

Browse files
committed
feat: update symbol TypeScript declarations
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent 92dc7c2 commit 05b6fa0

File tree

1 file changed

+43
-0
lines changed
  • lib/node_modules/@stdlib/symbol/docs/types

1 file changed

+43
-0
lines changed

lib/node_modules/@stdlib/symbol/docs/types/index.d.ts

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,11 @@
2222

2323
import AsyncIteratorSymbol = require( '@stdlib/symbol/async-iterator' );
2424
import Symbol = require( '@stdlib/symbol/ctor' );
25+
import HasInstanceSymbol = require( '@stdlib/symbol/has-instance' );
26+
import IsConcatSpreadableSymbol = require( '@stdlib/symbol/is-concat-spreadable' );
2527
import IteratorSymbol = require( '@stdlib/symbol/iterator' );
28+
import ReplaceSymbol = require( '@stdlib/symbol/replace' );
29+
import ToPrimitiveSymbol = require( '@stdlib/symbol/to-primitive' );
2630

2731
/**
2832
* Interface describing the `symbol` namespace.
@@ -51,6 +55,26 @@ interface Namespace {
5155
*/
5256
Symbol: typeof Symbol;
5357

58+
/**
59+
* Has instance symbol.
60+
*
61+
* ## Notes
62+
*
63+
* - This symbol is used to determine whether a constructor object recognizes an object as its instance.
64+
* - The symbol is only supported in ES6/ES2015+ environments. For non-supporting environments, the value is `null`.
65+
*/
66+
HasInstanceSymbol: typeof HasInstanceSymbol;
67+
68+
/**
69+
* Concat spreadable symbol.
70+
*
71+
* ## Notes
72+
*
73+
* - This symbol specifies whether an array-like object should be flattened to its array elements during concatenation.
74+
* - The symbol is only supported in ES6/ES2015+ environments. For non-supporting environments, the value is `null`.
75+
*/
76+
IsConcatSpreadableSymbol: typeof IsConcatSpreadableSymbol;
77+
5478
/**
5579
* Iterator symbol.
5680
*
@@ -60,6 +84,25 @@ interface Namespace {
6084
* - The symbol is only supported in ES6/ES2015+ environments. For non-supporting environments, the value is `null`.
6185
*/
6286
IteratorSymbol: typeof IteratorSymbol;
87+
88+
/**
89+
* Replace symbol.
90+
*
91+
* ## Notes
92+
*
93+
* - This symbol provides a method for replacing substrings matched by the current object.
94+
* - The symbol is only supported in ES6/ES2015+ environments. For non-supporting environments, the value is `null`.
95+
*/
96+
ReplaceSymbol: typeof ReplaceSymbol;
97+
98+
/**
99+
* Symbol which specifies a method for converting an object to a primitive value.
100+
*
101+
* ## Notes
102+
*
103+
* - The symbol is only supported in ES6/ES2015+ environments. For non-supporting environments, the value is `null`.
104+
*/
105+
ToPrimitiveSymbol: typeof ToPrimitiveSymbol;
63106
}
64107

65108
/**

0 commit comments

Comments
 (0)