Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
nanospinner
Advanced tools
nanospinner - npm Package Compare versions
Comparing version 0.1.7 to 0.1.8
| { | ||
| "name": "nanospinner", | ||
| "version": "0.1.7", | ||
| "version": "0.1.8", | ||
| "description": "Simple and tiny spinner library for Node.js", | ||
@@ -5,0 +5,0 @@ "keywords": [ |
128
README.md
@@ -19,127 +19,3 @@ # Nano Spinner | ||
| ## Benchmarks | ||
| The space in `node_modules` including sub-dependencies: | ||
| ``` | ||
| $ ./test/size.js | ||
| Data from packagephobia.com | ||
| ora 597 kB | ||
| cli-spinners 28 kB | ||
| mico-spinner 28 kB | ||
| nanospinner 25 kB | ||
| ``` | ||
| Library loading time: | ||
| ``` | ||
| $ ./test/loading.js | ||
| mico-spinner 13.014 ms | ||
| nanospinner 1.930 ms | ||
| ``` | ||
| ## API | ||
| <details> | ||
| <summary> | ||
| <b> | ||
| <code> | ||
| spin() | ||
| </code> | ||
| </b> | ||
| </summary> | ||
| Looping over `spin` method will animate a given spinner. | ||
| ```js | ||
| setInterval(() => { | ||
| spinner.spin() | ||
| }, 25) | ||
| ``` | ||
| </details> | ||
| <details> | ||
| <summary> | ||
| <b> | ||
| <code> | ||
| start() | ||
| </code> | ||
| </b> | ||
| </summary> | ||
| In order to start the spinner call `start`. This will perform drawing the spinning animation | ||
| ```js | ||
| spinner.start() | ||
| ``` | ||
| </details> | ||
| <details> | ||
| <summary> | ||
| <b> | ||
| <code> | ||
| stop() | ||
| </code> | ||
| </b> | ||
| </summary> | ||
| In order to stop the spinner call `stop`. This will finish drawing the spinning animation and return to new line. | ||
| ```js | ||
| spinner.stop() | ||
| spinner.stop('Done!') | ||
| ``` | ||
| </details> | ||
| <details> | ||
| <summary> | ||
| <b> | ||
| <code> | ||
| success() | ||
| </code> | ||
| </b> | ||
| </summary> | ||
| Use `success` call to stop the spinning animation and replace the spinning symbol with check mark character to indicate successful completion. | ||
| ```js | ||
| spinner.success() | ||
| spinner.success('Successful!') | ||
| ``` | ||
| </details> | ||
| <details> | ||
| <summary> | ||
| <b> | ||
| <code> | ||
| error() | ||
| </code> | ||
| </b> | ||
| </summary> | ||
| Use `error` call to stop the spinning animation and replace the spinning symbol with cross character to indicate error completion. | ||
| ```js | ||
| spinner.error() | ||
| spinner.error('Error!') | ||
| ``` | ||
| </details> | ||
| <details> | ||
| <summary> | ||
| <b> | ||
| <code> | ||
| reset() | ||
| </code> | ||
| </b> | ||
| </summary> | ||
| In order to reset the spinner to its initial frame do: | ||
| ```js | ||
| spinner.reset() | ||
| ``` | ||
| </details> | ||
| ## Roadmap | ||
| - [ ] Multi spinners | ||
| ## Docs | ||
| Read **[full docs](https://github.com/usmanyunusov/nanospinner#readme)** on GitHub. |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-17.93%
8348
- Number of lines in readme file
- decreased by-85.42%
21
No dependency changes