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

@palerock/ref

v0.1.5

Published

reference function for javascript

Downloads

13

Readme

Ref JS

Used for creating ref by using javascript

Get Start

Import the script

  1. Install from NPM or yarn
    npm i @palerock/ref
    yarn add @palerock/ref
  2. Download the source file - /build/ref.js or mini file /build/ref.mini.js

Using the script

  1. With NodeJS
    const {ref,refs} = require('@palerock/ref');
    Or using import keyword
    import {ref,refs} from '@palerock/ref';
  2. With HTML on browser
    <script src="./xxx/ref-mini.js"></script>
    <script>
        const {ref,refs} = window;
    </script>

Demo for Simple Usage

  1. Using with dom
    const {ref} = window;
    
    // select a dom
    const dom = document.querySelector('h1');
    
    // create ref
    const domRef = ref(
        dom, ['title'],
        ({title}, targetDom)=>{
            targetDom.innerHTML = title;
        }
    )
    
    // change the ref
    domRef.title = 'Hello Ref JS';
    
    console.log(dom.innerHTML); // Hello Ref JS
  2. Using with multi vars in NodeJS
    const {ref} = require('@palerock/ref');
    
    const dataSource = {
        project: {
            name: 'project 01'
        },
        owner: {
            name: 'Ryan'
        }
    }
    
    const dataRef = ref(
        dataSource,
        {
            // declare vars and setting the initial values
            projectName: 'Unknown Project Name',
            ownerName: 'Unknown Owner Name'
        },
        ({projectName, ownerName}, targetDataSource)=>{
            targetDataSource.project.name = projectName;
            targetDataSource.owner.name = ownerName;
        }
    )
    
    dataRef.projectName = 'project ref name';
    
    console.log(dataSource.project.name); // project ref name
    console.log(dataSource.owner.name); // Unknown Owner Name

Documentation

  • ref: function

    • description: create a ref with a object
    • arguments - ordered as following
    • target: Object what object the ref related.
    • vars: Object|<Array<String>> declare the vars used in the mapping function
    • mapping: function when the ref changed, what to do is following the function
      • callback arguments - ordered as following
      • ref: Object the ref Object
      • target: Object the target Object
  • refs: function

    • description: create a ref with multi objects
    • arguments - ordered as following
    • targets: List<Object> what objects the ref related.
    • vars: Object|<Array<String>> declare the vars used in the mapping function
    • mapping: function when the ref changed, what to do is following the function
      • callback arguments - ordered as following
      • ref: Object the ref Object
      • target: Object the target Object

Leave your comments with any question or suggestion please