83 lines
1.5 KiB
Markdown
83 lines
1.5 KiB
Markdown
|
<!--
|
||
|
|
|
||
|
|
@license Apache-2.0
|
||
|
|
|
||
|
|
Copyright (c) 2020 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.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
# nextTick
|
||
|
|
|
||
|
|
> Add a callback to the "next tick queue".
|
||
|
|
|
||
|
|
<section class="usage">
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var nextTick = require( '@stdlib/utils/next-tick' );
|
||
|
|
```
|
||
|
|
|
||
|
|
#### nextTick( clbk\[, ...args] )
|
||
|
|
|
||
|
|
Adds a callback to the "next tick queue".
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
function beep() {
|
||
|
|
console.log( 'boop' );
|
||
|
|
}
|
||
|
|
|
||
|
|
nextTick( beep );
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.usage -->
|
||
|
|
|
||
|
|
<section class="notes">
|
||
|
|
|
||
|
|
## Notes
|
||
|
|
|
||
|
|
- The queue is fully drained after the current operation on the JavaScript stack runs to completion and before the event loop is allowed to continue.
|
||
|
|
- Creating an infinite loop is possible if `nextTick` is called recursively.
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<section class="examples">
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
<!-- eslint no-undef: "error" -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var nextTick = require( '@stdlib/utils/next-tick' );
|
||
|
|
|
||
|
|
function beep( x, y, z ) {
|
||
|
|
console.log( 'boop: %d %d %d', x, y, z );
|
||
|
|
}
|
||
|
|
|
||
|
|
nextTick( beep, 1, 2, 3 );
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.examples -->
|
||
|
|
|
||
|
|
<section class="links">
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.links -->
|