Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

radix-tree

Package Overview
Dependencies
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

radix-tree

Node.js version of a radix tree usable for routers or url path based storage.

  • 0.3.4
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

radix-tree Build Status Coverage Status

Designed for usage in a router. Supports static paths with and without parameters/catchalls

Install

npm install radix-tree

Usage

Adding

const Tree = require('radix-tree').Tree

const instance = new Tree()

instance.add('/my_path', 'data')

console.log(instance.find('/my_path').data) // will output "data"

The second parameter in Tree.add() can be anything, a string, a function or an object. The stored path, data and contained parameters will be returned via Tree.find().

Removing

instance.remove('/my_path')

Will remove /my_path from the tree. Removing deeper paths like

instance.add('/my_path')
instance.add('/my_path/sub_path')

instance.remove('/my_path/sub_path') // will only remove /sub_path

Clearing

Its also possible to clear all routes at once.

instance.removeAll()

Priority

With version 0.2.0 routes are internally sorted by priority and no longer handled FIFO, routes with many childs have a higher priority and are scanned earlier.

Adding first /users and then /cart/add and /cart/remove will result in reordering of the children and place cart before users.Expl

(3) /
(2)   cart/
(1)     add
(1)     remove
(1)   users

Static routes

A static route can be any type of endpoint of a service, valid examples are:

  • /any_cool_file.html
  • /api/endpoint
  • /users/testuser/avatar.jpg

Static routes are the easiest to and fastest to lookup.

Routes including parameters

Parameters are dynamic parts of a url and terminated either by the end of the passed path or a /. A usage might be for a simple REST-API.

  • /api/users/:userId
  • /cms/:pageName

Tree.find() will contain now the params key with all found parameters and their corresponding values.

Routes including catchalls

Catchalls are a special type of parameters, they will match everything and only be terminated by the end of the passed path. Usage could be in a router to catch deep paths like a CDN or a full API, without caring for the structure.

  • /api/user/*api
  • /images/*path

Tree.find() will contain now the params key with all found parameters and their corresponding values.

Keywords

FAQs

Package last updated on 31 Jan 2016

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc