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

membean

v1.0.2

Published

A NodeJS Client for Membean

Downloads

6

Readme

Membean

The ultimate MemBean client API for all your training needs!

Introduction

This package is a versatile Node.js library designed to interact with the MemBean training platform, providing comprehensive access to training sessions, quizzes, spell tests, and more.

Installation

You can install MemBeanTrainingSession via npm:

npm install membean

Usage

Here's a quick guide on how to get started with Membean:

import MemBeanTrainingSession from 'membean';

// Initialize the session with your session ID and authentication token
const session = new MemBeanTrainingSession(sessionId, authToken);

// Listen to events emitted by the session
session.on('new_word', (data) => {
    console.log('New word:', data.word);
    // Handle new word event
});

// Start parsing user state and interacting with the session
session.parseUserState();

For more, see the documentation

Features

  • Event-driven Architecture: Utilize event listeners to react to different states during the training session.
  • Advanced Parsing: Parse detailed information about word learning, quizzes, spell tests, and more.
  • Flexible Advancement: Seamlessly advance through the training session with customizable time spent on each page.
  • Internal Methods: Access internal methods for advanced session manipulation.

Documentation

Classes

MemBeanTrainingSession

The main class representing a MemBean training session.

Events
  • new_word: Emitted when a new word is encountered.
  • restudy: Emitted when a word is being restudied.
  • quiz: Emitted during a quiz session.
  • spelltest: Emitted during a spell test session.
  • take_a_break: Emitted when it's time to take a break.
Methods
  • advance(advancement, timeOnPage): Advance the training session. Params: advancement (internal advancement object), timeOnPage (time spent on page in seconds).
  • _int_advance(event, barrier, args): Internal method for advancing the session.
  • parseUserState(): Parse the user state.
  • _parseUserState(res): Internal method for parsing the user state.
  • parseWordLearn($, type): Parse word learning data.
  • parseQuiz($): Parse quiz data.
  • parseSpellCheck($): Parse spell test data.
  • parseTakeABreak($): Parse take a break data and terminate session.

Contributions

Contributions are welcome! Feel free to submit issues or pull requests on GitHub.

License

This project is licensed under the Creative Commons Attribution 4.0 International License - see the LICENSE file for details.

Author

Written with ❤️ by Aviv Keller [email protected].