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

@ptolemy2002/react-hook-result

v1.0.2

Published

Example of a React library

Downloads

199

Readme

React Hook Result

There are two common ways to implement a hook that returns a result:

  1. Returning an array and accessing with [a, b, ...] = useHook()
  2. Returning an object and accessing with {a, b, ...} = useHook()

Under these circumstances, the two are mutually exclusive. This library provides a class that allows accessing hook values in both ways with one object. Simply return an instance of HookResult in your hook.

The class is exported as default, so you can import in one of the following ways:

// ES6
import HookResult from '@ptolemy2002/react-hook-result';
// CommonJS
const HookResult = require('@ptolemy2002/react-hook-result');

Classes

The following classes are available in the library:

HookResult

Description

A class that allows accessing hook values in both array and object forms. This is useful for hooks that return multiple values, as it allows the user to access the values in the way that is most convenient for them. Accessing a property of the object directly will first look for an existing property with that name, and if it does not exist, it will get the value from the _data object.

Parameters

  • data (Object): The data to be returned by the hook. This should be an object with the keys being the names of the values and the values being the values themselves.
  • order (Array): The order in which each key should be accessed to be iterated over. Any key not present in this array will be placed at the end in the order that they appear when iterating over the object, which may not be consistent across browsers.

Instance Properties

  • _data (Object): The object that holds this instance's data. It is of type Map so that we can save the order of the keys consistently. You should never need to directly access this property, but you can.

Meta

This is a React Library Created by Ptolemy2002's cra-template-react-library template in combination with create-react-app. It contains methods of building and publishing your library to npm. For now, the library makes use of React 18 and does not use TypeScript.

Peer Dependencies

These should be installed in order to use the library, as npm does not automatically add peer dependencies to your project.

  • @types/react: ^18.3.3
  • @types/react-dom: ^18.3.0
  • react: ^18.3.1
  • react-dom: ^18.3.1

Commands

The following commands exist in the project:

  • npm run uninstall - Uninstalls all dependencies for the library
  • npm run reinstall - Uninstalls and then Reinstalls all dependencies for the library
  • npm run example-uninstall - Uninstalls all dependencies for the example app
  • npm run example-install - Installs all dependencies for the example app
  • npm run example-reinstall - Uninstalls and then Reinstalls all dependencies for the example app
  • npm run example-start - Starts the example app after building the library
  • npm run build - Builds the library
  • npm run release - Publishes the library to npm without changing the version
  • npm run release-patch - Publishes the library to npm with a patch version bump
  • npm run release-minor - Publishes the library to npm with a minor version bump
  • npm run release-major - Publishes the library to npm with a major version bump