Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Latest commit

History

43 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

Pulldown API

Registry for pulldown.

Add a set or alias by submitting a pull request.

Endpoints

MethodURLDescription
GET/Get the current registry object
GET/set/:identifierGet the set for a given identifier. This will be a list of further identifiers or URLs.

Terminology

NameDescription
IdentifierString used to identify a URL, alias or set.
AliasAn identifier that refers to another identifier in the registry. For example, underscore points to underscore.js.
SetAn array of identifiers or URLs.

What it does

The Pulldown API is accessed when pulldown fails to resolve an identifier (say, jquery) to a URL locally. It checks its registry for a URL, alias or set associated with that identifier.

If it is found in the registry, a set is sent back to the client.

If it's not, the API searches CDNJS for a matching identifier. If it finds it, it returns a set containing the matched URL. Otherwise it returns a 404 with an empty set.

Testing

To run the tests:

$ foreman start -p 9005

In another tab:

$ npm test

License

MIT

About

Pulldown API. Common aliases and sets.

Resources

Stars

3 stars

Watchers

2 watching

Forks

Releases

Packages

Contributors

Languages