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

ndrf

v2.2.0

Published

Query your django rest framework api easily, many tools to join your node app with a django rest framework api fast and simple.

Downloads

5

Readme

#node django rest framework Query your django rest framework api easily, many tools to join your node app with a django rest framework api fast and simple.

##HOW TO USE ###ndrf(protocol:String, domain:String, opts:Object[Optional])

var ndrf = require('ndrf')
var protocol = 'http'
var domain = 'ndrf.test'

var api = ndrf.api(protocol, domain, {
	'tokenSlug': '/api-token-auth/', //Default '/api-token-auth/'
	'apiSlug': '/api', //Default '/api'
	'PORT': 80 //Default 80
})

###Request object Contains CRUD(get, post, put, patch, delete) methods and, whether you don't choose otherwise, the body will returned json parsed.

On request object, the requests will make using 'apiSlug' option , in other words, under '/api' slug by default. Then whether we send a request to '/proof', you are actually sending a request to '/api/proof'. Whether you don't want to use this feature, set 'apiSlug' to '/' or any slug under live your api.

####GET Request (slug:String, callback:Function, json:Boolean[Default: true])

var request = api.request
var expectedStatusCode = 200

request
	.get('/foo/url', (err, res, jsonBody) => {
		if (err || res.statusCode !== expectedStatusCode) throw new Error('Something went wrong.')
		
		//Do something with body parsed in json.
	})

####POST, PATCH, PUT, DELETE Requests (slug:String, data:Object, callback:Function, json:Boolean(Default: true))

var userData = {username: 'foo', password: 'fooito5632'}

request
	.post('/user/login', userData, (err, res, jsonBody) => {
		if (err || res.statusCode !== expectedStatusCode) throw new Error('Something went wrong.')
		
		//Do something with body parsed in json.
	})

###Token Request object It works equal to request object, simply append the Authorization Header your token.

####Token Request (token[String])

var authorizationToken = '200444c77cf8u7f953c921cf7278a17459204y20'
var request = api.tokenRequest(authorizationToken)
var expectedStatusCode = 200

request
	.get('/foo/url', (err, res, jsonBody) => {
		if (err || res.statusCode !== expectedStatusCode) throw new Error('Something went wrong.')
		
		//Do something with body parsed in json.
	})

###DJANGO REST FRAMEWORK SPECIFIC FEATURES ####Token User Authentication Send request to '/api-token-auth/' slug by default, you can change 'tokenSlug' option to any custom slug.

var ndrf = require('ndrf')
var protocol = 'http'
var domain = 'ndrf.test'

var api = ndrf.api(protocol, domain)

var userData = {username: 'foo', password: 'fooito5632'}

api.auth.user(userData, (err, res, jsonBody) => {
	if (err || res.statusCode !== expectedStatusCode) throw new Error('Something went wrong.')
	
	//Do something with body parsed in json.
})

###EXPRESS MIDDLEWARE

var ndrfMiddleware = require('ndrf').apiMiddleware

app.use(ndrfMiddleware)

//or

app.use((req, res, next) => {
	ndrfMiddleware(req, res, next, {
		host: 'ndrf.com' //By default use 'host' or 'origin' header.	
	})
})