Component Search

Next version of Component's search-api. Instead of having a dedicated search server, a JSON file of crawled components is used in both the client and server instead. This library is available in both the browser and node.js.

The search algorithm is currently very rudimentary. Please advise!

Node API

var components = yield* search(options)

• text - search through the .name and .description of components for text
• keywords - filter components by each keyword
• owner - filter components by a GitHub user or organization
• limit - maximum number of results

By default, components are sorted by stars/watchers, descending.

If you want to use a callback instead like the browser API, wrap search in co like: var search = co(require('component-search2')).

Browser API

search(options, function (err, components) {})

The browser API is the same except with a callback instead.

License

(The MIT License)

Copyright (c) 2014 segmentio <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.