npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@bitpas/typist

v0.2.1

Published

Animated typing utility

Downloads

3

Readme

Typist

Animated typing utility.

Installation

Install @bitpas/typist with npm.

npm install @bitpas/typist

Usage

Import

Import Typist as an ES module

import Typist from '@bitpas/typist';

or require as CommonJS.

const Typist = require('@bitpas/typist');

Initialize

Declare a new instance of Typist.

The Typist instance method takes two arguments: a required callback to which Typist's output is passed as the argument, and an optional configuration object to override Typist's defaults.

const myCallback = (output) => console.log(output);
const myOptions = { speed: 320 };
const myTypist = new Typist(myCallback, myOptions);

Run

On the initialized instance of Typist, pass the desired output as a string to the type method, and call the start method to begin the animation.

myTypist.type('My typed message.').start();

React hook example

import React, { useEffect, useState } from 'react';
import Typist from '@bitpas/typist';

const Component = () => {
  const [greeting, setGreeting] = useState('');

  useEffect(() => {
    const greetingTypist = new Typist(setGreeting);
    greetingTypist.type('foobar').start();

    return function cleanup() {
      greetingTypist.stop();
    };
  }, []);

  return <h1>{greeting}</h1>;
};

export default Component;

Combining methods

Non-chainable methods

The instance methods start and stop are not chainable. start should come at the end of a method chain to begin the animation. stop is useful in cases such as React effect cleanup.

Chainable methods

The instance methods type, backspace, and pause can be chained to create complex output.

myTypist
  .type('Delete me')
  .backspace('all')
  .type('Vowels: aeiouy')
  .pause(500)
  .backspace()
  .type('[y]')
  .pause(1000)
  .backspace(3)
  .type(' and sometimes y')
  .start();

API

new Typist(callback, [options])

  • Arguments
    • callback: function - Callback to which the output from Typist is passed as an argument
    • options: object - Optional configuration settings
  • Returns: Typist

Non-chainable instance methods

Typist.start()

  • Arguments: none
  • Returns: undefined

Typist.stop()

  • Arguments: none
  • Returns: undefined

Chainable instance methods

Typist.type(string)

  • Arguments
    • string string: Output to callback
  • Returns: Typist instance object

Typist.backspace(value)

  • Arguments
    • value number or string:
      • n: Delete n characters
      • 'all': Delete output length
      • Default: 1
  • Returns: Typist instance object

Typist.pause(value)

  • Arguments
    • value number: time in milliseconds
  • Returns: Typist instance object

Options

// default options
const defaults = {
  speed: 120,
};

speed number

  • Speed of the animation in milliseconds