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

shieldfy-nodejs-client

v0.5.3

Published

shieldfy nodejs official sdk

Downloads

8

Readme

Shieldfy NodeJs SDK - Beta

This is the official NodeJs SDK for Shieldfy (shieldfy.io) https://shieldfy.io

Shieldfy is a strong application protection platform that helps businesses to secure their applications online.

Installation

  1. You will first need to register on shieldfy.io to get your APP Key & APP Secret.
  2. install nodejs sdk package through NPM (recommanded)
    npm install shieldfy-nodejs-client

Usage

open index.js or (main file) and type the following:

index.js File

const shieldfy= require('shieldfy-nodejs-client');
shieldfy.start({
    appKey:'yourAppKey',
    appSecret:'YourAppSecret',
});

Or, in case using environment variable (.env File)

index.js File

const shieldfy= require('shieldfy-nodejs-client')
shieldfy.start();

.env File

shieldfyAppKey = "yourAppKey"
shieldfyAppSecret = "YourAppSecret"

NOTE: You should require Shieldfy in the main file at first before any other package or module in order to SDK work correctly.

Detection-Mode

BLOCK

This is default mode in which if there exist attack on your application SDK will stop the attack and block it then report to the shieldfy dashboard.

LISTEN

In this mode the SDK will not bloack any attack but it will still report this attacks to shieldfy dashboard. to activate this mode pass action property equal "listen" in the object to the shieldfy.start() function as following

const shieldfy= require('shieldfy-nodejs-client');
shieldfy.start({
    appKey:'yourAppKey',
    appSecret:'YourAppSecret',
    action: 'listen'
});

Configuration

For more information about configurations and usage, refer to the official documentation at docs.shieldfy.io.

Contributing

Thank you for considering contributing to this project! Bug reports, feature requests, and pull requests are very welcome.

Security Vulnerabilities

If you discover a security vulnerability within this project, please send an e-mail to [email protected].