@harlem/extension-reset

The official reset extension for Harlem

Usage no npm install needed!

<script type="module">
  import harlemExtensionReset from 'https://cdn.skypack.dev/@harlem/extension-reset';
</script>

README

Harlem Reset Extension

npm

This is the official reset extension for Harlem. The reset extension adds the ability to reset a store back to it's initial state.

Getting Started

Follow the steps below to get started using the reset extension.

Installation

Before installing this extension make sure you have installed @harlem/core.

yarn add @harlem/extension-reset
# or
npm install @harlem/extension-reset

Registration

To get started simply register this extension with the store you wish to extend.

import resetExtension from '@harlem/extension-reset';

import {
    createStore
} from '@harlem/core';

const STATE = {
    firstName: 'Jane',
    lastName: 'Smith'
};

const {
    state,
    getter,
    mutation,
    reset
} = createStore('example', STATE, {
    extensions: [
        resetExtension()
    ]
});

The reset extension adds a single reset method to the store instance.

Usage

Resetting a store

to reset a store simply call the reset method returned from the store instance.