slync

       

         

       

       

---

0 dependencies event-loop blocking synchronous sleep

sleep + sync = slync

modelled after atomic-sleep

---

• 1. Installation
• 2. Usage
• 3. License
• 4. Limitations
• 5. Caveats

1. Installation

npm install slync

2. Usage

Try with Replit.

slync(ms) // where ms is the number of milliseconds

Example usage of synchronously sleeping for 2 seconds:

// import slync from 'slync';
const slync = require('slync');

console.log(`0. Current time: ${new Date()}`);

setTimeout(() => {
  console.log(`2. Prints second because slync blocks: ${new Date()}`);
}, 100);

slync(2000);

console.log(`1. Prints first after 2000 milliseconds: ${new Date()}`);

3. License

Massachusetts Institute of Technology (MIT)

Copyright (c) 2023 Khiet Tam Nguyen

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the “Software”),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

4. Limitations

There are currently no known limitations.

5. Caveats

slync is modelled after atomic-sleep, with some minor differences:

• slync is written in TypeScript
• slync only accepts 'number' for the ms parameter whereas atomic-sleep also accepts 'bigint'
• slync will determine which sleep method to use (atomic vs naive) at runtime

For synchronous non-blocking sleep, look into deasync.