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

@raydeck/dependency-tree-resolver

v1.0.7

Published

An easy-to-use library to resolve dependencies in a dependency tree

Downloads

24

Readme

@raydeck/dependency-tree-resolver - v1.0.7Globals

@raydeck/dependency-tree-resolver - v1.0.7

dependency-resolver

If you have a dependency tree, and you'd like to know in which order to initialize each node, this library is for you.

How to use

Node

In CLI, execute

npm i dependency-tree-resolver --save-dev

and then

var DepResolver =  require('dependency-tree-resolver');

Browser

Get a local copy of dep-res.js, or consume it via RawGit's CDN, and add to your HTML:

<script type="text/javascript" src="dep-res.js"></script>

and then you'll have DepResolver on the window scope.

API

Once you include the script in your project you'll have a function DepResolver which accepts two arguments:

DepResolver(
    tree = {
        string: [...string],
        ...
    }, 
    options = {
        exclude: [...string]
    }
)

Arguments

  • tree: each key in the map represents a node in the tree, and each value in the array represents a single dependency of that node.
  • options:
    • exclude: allows you to specify which dependencies are special and allowed to not have a node for themselves (usefull when depending on external resources)

Examples

//valid tree
var tree = {a: [], b: ['c', 'd'], c: ['d'], d: ['a']};
var resolved = DepResolver(tree);
console.log(resolved);//['a','d','c','b' ]

//invalid tree w/ excluded external resource
var tree = {a: ['b'], b: ['d']};
var options = {exclude: ['d']};
var resolved = DepResolver(tree, options);
console.log(resolved);//['b','a']

//invalid tree w/o excluded external resource
var tree = {a: ['b'], b: ['d']};
var resolved = DepResolver(tree);//throw error: "b" has an unknown dependency "d"

//invalid tree with cyclic dependency
var tree = {a: ['b'], b: ['c'], c: ['a'], d: ['e'], e: ['d']};
var resolved = DepResolver(tree);//throw error: circular dependency found: a > b > c > a

License

This library is provided under the MIT license.

@raydeck/dependency-tree-resolver - v1.0.7GlobalsDepResolverError

Class: DepResolverError

Hierarchy

  • Error

    DepResolverError

Index

Constructors

Properties

Constructors

constructor

+ new DepResolverError(message: string): DepResolverError

Defined in src/index.ts:1

Parameters:

Name | Type | ------ | ------ | message | string |

Returns: DepResolverError

Properties

message

message: string

Inherited from DepResolverError.message

Defined in node_modules/typescript/lib/lib.es5.d.ts:974


name

name: string

Inherited from DepResolverError.name

Defined in node_modules/typescript/lib/lib.es5.d.ts:973


Optional stack

stack? : undefined | string

Inherited from DepResolverError.stack

Defined in node_modules/typescript/lib/lib.es5.d.ts:975


Static Error

Error: ErrorConstructor

Defined in node_modules/typescript/lib/lib.es5.d.ts:984

@raydeck/dependency-tree-resolver - v1.0.7Globals

@raydeck/dependency-tree-resolver - v1.0.7

Index

Classes

Functions

Functions

removeExcluded

removeExcluded(depMap: object, node: string, excludeItems: string[]): void

Defined in src/index.ts:6

Parameters:

Name | Type | ------ | ------ | depMap | object | node | string | excludeItems | string[] |

Returns: void


resolve

resolve(depMap: object, options?: undefined | object): string[]

Defined in src/index.ts:67

Parameters:

Name | Type | ------ | ------ | depMap | object | options? | undefined | object |

Returns: string[]


resolveSpecific

resolveSpecific(depMap: object, result: string[], dependant: string, path: string[]): void

Defined in src/index.ts:43

Parameters:

Name | Type | ------ | ------ | depMap | object | result | string[] | dependant | string | path | string[] |

Returns: void


validateDep

validateDep(depMap: object, node: string, dependency: string): void

Defined in src/index.ts:16

Parameters:

Name | Type | ------ | ------ | depMap | object | node | string | dependency | string |

Returns: void


validateDepMap

validateDepMap(depMap: object, options?: undefined | object): void

Defined in src/index.ts:28

Parameters:

Name | Type | ------ | ------ | depMap | object | options? | undefined | object |

Returns: void