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

@yokowasis/firegun

v1.9.2

Published

gunDB Wrapper for easy access and use.

Downloads

11

Readme

Firegun

Why the Name?

Because it's inspired by fireship youtube video, and I am trying to replace Firestore with GunDB (Decentralized Database)

What is it ?

It's a wrapper for gunDB. gunDB is great, but sometimes the docs is confusing.

Quickstart

Installation

npm i gun @yokowasis/firegun

Include the module

import { Firegun } from '@yokowasis/firegun'
// or
const Fg = require('@yokowasis/firegun');
const Firegun = Fg.Firegun;

Initialization

let fg = new Firegun();

Do

var data = {
    "Hello" : "World"
}

//Put Some Data
let success = await fg.Put("data/dummy",data);

//Retrieve Some Data
let retrieveData = await fg.Get("data/dummy");

API Reference

Public Space

Get

let data = await fg.Get("path/to/the/things")

Load

// Load Multi Nested Data
let data = await fg.Load("path/to/the/things")

Put

let success = await fg.Put("path/to/the/things",{
    "hello" : "world",
    "parent" : {
      "nested" : "data"
    }
})

Userspace

What is it ? It's a space for user. The data written in this way is readonly for the public.

Create new User (it logged them in automatically)

await fg.userNew ("username", "password")
console.log (fg.user)

Login User

await fg.userLogin ("username", "password")
console.log (fg.user)

Logout User

await fg.userLogout ()
console.log (fg.user)

Get Data from User Space

let data = await fg.userGet ("mydata")

Get Data from User Space

//Load Multi Nested Data
let data = await fg.userLoad ("mydata")

Put Data to User Space

let success = await fg.userPut ("mydata",{
    "Hello" : "Userspace"
})

SEASpace

What is it? It's like the UserSpace, but without the username / password

Put Permanent Readonly Content

//Key Must begin with "#"
let success = fg.addContentAdressing("#permanentStuff",{
    "Hello" : "Can't Touch Me"
})

//Try to read it
let data = await fg.Get("#permanentStuff");
for (const key in data) {
  const element = data[key];
  console.log (element);
}

//or using gun.map()
fg.gun.get("#permanentStuff").map().once(element=>{
    console.log (element)
})

//Try to change it
let success = await fg.Put("#permanentStuff",{
    "New"   : "entry"
})
//will fail

Generate KeyPair

What is it for ? it's to create a user without username / password.

let keyPair = await fg.generatePair();

Login to Userspace with KeyPair

await fg.loginPair (keyPair);
console.log (fg.user);