seeq

Version:

Search or detect name on some resource (GitHub, NPM, Bower, ...)

10 lines (9 loc) • 52.1 kB

HTML

<html> <head> </head> <body style="background: transparent;"> <script src="scripts/docstrap.lib.js"></script> <script src="scripts/lunr.min.js"></script> <script src="scripts/fulltext-search.js"></script> <script type="text/x-docstrap-searchdb"> {"modules.list.html":{"id":"modules.list.html","title":"Modules","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Modules Classes FailedHttpRequestError IncorrectResponseError × Search results Close "},"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Classes Classes FailedHttpRequestError IncorrectResponseError × Search results Close "},"index.html":{"id":"index.html","title":"Index","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError seeq Detect whether a name is registered or present on some resource (GitHub, NPM, Bower, ...). Also allows searching for string on specified resources. Available resources The following resources are available: GitHub NPM Bower Registry of Grunt plugins Registry of Gulp plugins JSter MicroJS CDNJS Web components You can see information about all available resources by running seeq -l (see below). Installation To install and use seeq Node.js should be installed in your system. Run the following command to install seeq: npm install -g seeq Usage Run seeq to show usage information. > seeq Usage: seeq [name]... [options] name Name/string that should be searched for or checked for presence on a resource Options: -h, --help Show usage information and exit -l, --list-resource Show information about all available resources -r, --at Filter for available resources by name: comma-separated list of names (case-insensitive) of resources that should be checked/searched -t, --tag Filter for available resources by tag: comma-separated list of tags (case-insensitive); -tag means that resource should not have the tag --all-tag Whether all specified tags should be checked for a resource -p, --partial-match Allow partial matching when checking name: 0 - disallow (by default), 1 - allow at the beginning of matching strings, 2 - allow substring matching -c, --case-sensitive Use case-sensitive check/search when possible -s, --search Make search instead of check -m, --limit Limit of quantity of results per resource --timeout Number of seconds to wait for a response before aborting a data request to a resource [60] -f, --format Result format; can be: text, json, markdown, raw [text] -V, --verbose Enable verbose output -v, --version Show program version --github-lang Search GitHub repositories that are written in the specified language --github-limit Limit of quantity of GitHub results; default and maximum value is 100 --github-user GitHub username that should be used for authentication --github-password GitHub account password --github-token GitHub OAuth2 token that should be used for authentication instead of username and password Available resources (9): * GitHub (https://github.com) - GitHub repositories (tags: github repository project library framework package) * NPM (https://npmjs.org) - Node packaged modules registry (tags: npm js javascript package library node) * Bower (https://bower.io) - Bower package manager registry (tags: bower js javascript package component library browser) * Grunt (https://gruntjs.com/plugins) - Registry of Grunt plugins (tags: grunt js javascript plugin registry node task runner) * Gulp (https://gulpjs.com/plugins) - Registry of Gulp plugins (tags: gulp js javascript plugin registry node build) * JSter (http://jster.net) - Catalog of JavaScript libraries and tools for web development (tags: jster js javascript catalog library framework tool) * MicroJS (http://microjs.com) - List of micro-frameworks and micro-libraries (tags: microjs js javascript library framework micro) * CDNJS (https://cdnjs.com) - CDN for popular web development frameworks, libraries, CSS and other assets (tags: cdnjs cdn js javascript library framework css browser) * Web components (https://www.webcomponents.org) - Share and discover reusable web UI components (tags: webcomponents customelements web component webcomponent custom element js javascript css html gallery browser) To make a search you can use sees command (sees equals to seeq -s). Formats It is possible to specify format of search result: text - result will be converted into plain text; default format json - result will be converted into JSON markdown - result will be converted into Markdown raw - result will be returned \"as is\" (raw JSON): in usual mode auxiliary data about resources will be deleted, in verbose mode no processing will be applied Examples Check numgen, three and some-strange-name at resources having package tag and limit results per resource up to 5. > seeq numgen three some-strange-name --tag package --limit 5 Checking GitHub, NPM, Bower... Progress: 9/9 (100%) Results: 1. numgen GitHub - 5 numgen - Creates objects that generate number sequences url: https://github.com/gamtiq/numgen numgen - A little Go command line application to generate ranges of numbers url: https://github.com/maurogestoso/numgen numgen url: https://github.com/namumba22/numgen numgen url: https://github.com/gbochev/numgen numgen - numger prediction url: https://github.com/sndemo/numgen NPM - 1 numgen - Creates objects that generate number sequences url: https://github.com/gamtiq/numgen keywords: number sequence generator Bower - 1 numgen - Creates objects that generate number sequences url: https://github.com/gamtiq/numgen keywords: number sequence generator 2. three GitHub - 3 three - Totally not inspired Rust 3D library url: https://github.com/three-rs/three three - An easy-to-use Python wrapper for the Open311 API. url: three.codeforamerica.org three - A GPL (v2) and Creative Commons (for the assets) game for the ioquake3 engine. url: http://www.ioquake3.org/ NPM - 1 three - JavaScript 3D library url: https://threejs.org/ keywords: three three.js 3d canvas svg webgl Bower - 1 three url: https://github.com/mrdoob/three.js 3. some-strange-name GitHub some-strange-name is not found. NPM some-strange-name is not found. Bower some-strange-name is not found. Check mixing and flight at GitHub and Bower, allow partial matching at the beginning, use case-sensitive search, limit Bower results up to 3 and GitHub results up to 5, include only GitHub projects that are written in JavaScript, show additional information about found items. > seeq mixing flight -r github,bower --partial-match 1 -c --bower-limit 3 --github-limit 5 --github-lang js --verbose Checking GitHub, Bower... Progress: 4/4 (100%) Results: 1. mixing GitHub - 5 mixing - Functions to mix, filter, change and copy/clone objects url: https://github.com/gamtiq/mixing repository: https://github.com/gamtiq/mixing.git language: JavaScript stars: 14 mixing-console-example - Audio mixing console UI example url: https://github.com/wisdman/mixing-console-example repository: https://github.com/wisdman/mixing-console-example.git language: JavaScript license: MIT stars: 3 mixingloom-profiler-example - an example of profiling by mixingloom-profiler url: https://github.com/wighawag/mixingloom-profiler-example repository: https://github.com/wighawag/mixingloom-profiler-example.git language: JavaScript stars: 2 mixing - Spotify API for adding songs and playlists url: https://github.com/forevernitch/mixing repository: https://github.com/forevernitch/mixing.git language: JavaScript mixingMachine - program for new machines url: https://github.com/heidgera/mixingMachine repository: https://github.com/heidgera/mixingMachine.git language: JavaScript Bower - 1 mixing - Functions to mix, filter, change and copy/clone objects url: https://github.com/gamtiq/mixing keywords: mix merge mixin assign object filter map change copy clone modify update version: 1.2.5 repository: https://github.com/gamtiq/mixing.git license: MIT 2. flight GitHub - 5 flight - A component-based, event-driven JavaScript framework from Twitter url: http://flightjs.github.io/ repository: https://github.com/flightjs/flight.git language: JavaScript license: MIT stars: 6639 flightplan - Run sequences of shell commands against local and remote hosts. url: https://www.npmjs.com/package/flightplan repository: https://github.com/pstadler/flightplan.git language: JavaScript license: MIT stars: 1782 flightDelay - FlightDelay Project url: https://github.com/etherisc/flightDelay repository: https://github.com/etherisc/flightDelay.git language: JavaScript license: MIT stars: 115 flightSimPanels - Flight Simulator Instrument Panels on your Browsers, using UDP over Node.js and Socket.io url: https://github.com/dmolin/flightSimPanels repository: https://github.com/dmolin/flightSimPanels.git language: JavaScript license: GPL-3.0 stars: 85 flightSimulator - Eurofighter Typhoon simulated driving(???????????) url: https://github.com/renjianfeng/flightSimulator repository: https://github.com/renjianfeng/flightSimulator.git language: JavaScript stars: 39 Bower - 3 flight - Clientside component infrastructure url: https://github.com/flightjs/flight version: 1.5.1 repository: https://github.com/flightjs/flight.git flight-yql url: https://github.com/msecret/flight-yql version: 0.2.2 repository: https://github.com/msecret/flight-yql.git flight-withEach url: https://github.com/olivierlesnicki/flight-withEach version: 1.0.0 repository: https://github.com/olivierlesnicki/flight-withEach.git Search for pegasus at resources that have tag library and do not have tags node and cdn, limit results per resource up to 5, print the search result in JSON format. > sees pegasus -m 5 --tag library,-node,-cdn --all-tag -f json Checking GitHub, Bower, JSter, MicroJS... Progress: 4/4 (100%) Results: { \"pegasus\": { \"GitHub\": { \"result\": [ { \"name\": \"pegasus\", \"description\": \"A distributed key-value storage system developed and maintained by Xiaomi Cloud Storage Team.\", \"url\": \"https://pegasus-kv.github.io/\" }, { \"name\": \"pegasus\", \"description\": \"Load JSON while still loading other scripts\", \"url\": \"http://typicode.github.io/pegasus/\" }, { \"name\": \"pegasus\", \"description\": \"VM based deployment for prototyping Big Data tools on Amazon Web Services\", \"url\": \"https://github.com/InsightDataScience/pegasus\" }, { \"name\": \"pegasus\", \"description\": \"Pegasus Workflow Management System - Automate, recover, and debug scientific computations.\", \"url\": \"https://pegasus.isi.edu/\" }, { \"name\": \"Pegasus\", \"description\": \"A PEG parser generator for .NET that integrates with MSBuild and Visual Studio.\", \"url\": \"http://otac0n.com/Pegasus/\" } ] }, \"Bower\": { \"result\": [ { \"name\": \"pegasus\", \"description\": \"Load data while still loading other scripts, works with jQuery, Backbone, Angular...\", \"url\": \"https://github.com/typicode/pegasus\", \"keywords\": [ \"ajax\", \"promise\", \"xhr\", \"http\", \"request\", \"XMLHttpRequest\", \"data\", \"json\", \"bootstrap\", \"performance\", \"optimization\", \"load\", \"loader\", \"preload\", \"preloader\" ] } ] }, \"JSter\": { \"result\": [] }, \"MicroJS\": { \"result\": [ { \"name\": \"Pegasus\", \"description\": \"Load JSON data while still loading other scripts (xhr + promise).\", \"url\": \"https://github.com/typicode/pegasus\", \"keywords\": [ \"AJAX\", \"JSON\", \"GET\", \"xhr\", \"request\", \"promise\", \"parallel\", \"performance\", \"load\", \"preload\" ] } ] } } } API In your program you can use API provided by seeq in the following way: var seeq = require(\"seeq\"); ... function onProgress(data) { console.log([data.number, \"/\", data.total, \": checked \", data.name, \" at \", data.resource, \", results - \", data.result.result.length].join(\"\")); } seeq.search([\"chronoman\", \"knockout\", \"joy\"], callback, { resource: [\"NPM\", \"Github\", \"web components\"], settings: { _general: { limit: 5, partialMatch: 2, caseSensitive: true }, github: { limit: 10, language: \"js\" } }, progressCallback: onProgress }); ... seeq.searchName(\"duratiform\", callback, {resource: [\"Bower\", \"MicroJS\"]}); ... seeq.searchName(\"cheerio\", callback, { search: true, resourceTag: [\"library\", \"-cdn\"] }); ... seeq.search([\"adam\", \"eva\"], function(resultMap) { console.log( seeq.format.format(resultMap, \"json\", {queryList: [\"eva\", \"adam\"], verbose: true}) ); }); See JSDoc-generated documentation in doc folder. Contributing In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt. License Copyright (c) 2014-2020 Denis Sikuler Licensed under the MIT license. × Search results Close "},"module-bower.html":{"id":"module-bower.html","title":"Module: bower","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Module: bower Module that provides means to check/search in Bower. Methods <static> detect(name, callback [, settings]) Check whether package with the specified name is existent, or make search for the specified string. Data about found packages will be passed into callback as array. If no package is found, empty array will be passed into callback. Parameters: Name Type Argument Description name String Name of the package to check or string to search for. callback function Function that should be called to process operation's result. settings Object <optional> Operation settings. The following settings are supported (name - type - description): caseSensitive - Boolean - Whether case-sensitive check/search should be used partialMatch - Integer - Allow partial matching when checking name: 0 - disallow (by default), 1 - allow at the beginning of matching strings, 2 - allow substring matching search - Boolean - Whether search should be made instead of check limit - Integer - Limit of quantity of results requestTimeout - Integer - Number of milliseconds to wait for a response before aborting a data request × Search results Close "},"module-cdnjs.html":{"id":"module-cdnjs.html","title":"Module: cdnjs","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Module: cdnjs Module that provides means to check/search in CDNJS. Methods <static> detect(name, callback [, settings]) Check whether library with the specified name is existent, or make search for the specified string. Data about found libraries will be passed into callback as array. If no library is found, empty array will be passed into callback. Parameters: Name Type Argument Description name String Name of the library to check or string to search for. callback function Function that should be called to process operation's result. settings Object <optional> Operation settings. The following settings are supported (name - type - description): caseSensitive - Boolean - Whether case-sensitive check/search should be used partialMatch - Integer - Allow partial matching when checking name: 0 - disallow (by default), 1 - allow at the beginning of matching strings, 2 - allow substring matching search - Boolean - Whether search should be made instead of check limit - Integer - Limit of quantity of results requestTimeout - Integer - Number of milliseconds to wait for a response before aborting a data request <static> prepareData(data) Convert received library data to normalized form. Parameters: Name Type Description data Object Source data. Returns: Normalized data. Type Object × Search results Close "},"module-cli.html":{"id":"module-cli.html","title":"Module: cli","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Module: cli Command-line interface. Methods <static> cli( [options]) Perform operation specified via command-line arguments. Parameters: Name Type Argument Description options Object <optional> Predefined values for command-line options. Each option specified in this object will be used only when the corresponding option is not set in command-line arguments. See: run <static> run( [args]) Perform operation using specified options. Parameters: Name Type Argument Description args Object <optional> Operation options. × Search results Close "},"module-format.html":{"id":"module-format.html","title":"Module: format","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Module: format API to work with formatters that can be used to format result of search. Each formatter is a function that should return string representing result of search. The following parameters are passed to the format function: object that is result of search object that represents format settings; the following settings can be used (name - type - description): queryList - Array - list of names/strings that were checked/searched verbose - boolean - whether basic or detailed result should be returned Methods <static> exists(name) Check whether formatter with specified name exists. Parameters: Name Type Description name String Name that should be checked. See: get Returns: true if there is a formatter with the specified name, false if no one of formatters has the specified name. Type Boolean <static> format(data, name [, settings]) Format result of search by using specified formatter. Parameters: Name Type Argument Description data Object Result of search. name String Name of formatter that should be used. settings Object <optional> Format settings. Default values for settings are the following: queryList - extracted from data parameter verbose - false Returns: Result returned by specified formatter or empty string if no one of formatters has the specified name. Type String <static> get(name) Return formatter with specified name. Parameters: Name Type Description name String Name of formatter that should be returned. Returns: Function that represents formatter or null if no one of formatters has the specified name. Type function | null <static> getMap() Return object that represents all available formatters. Returns: Object that represents all available formatters. Fields are names of formatters, values are corresponding formatters. Type Object <static> getNameList() Return list containing names of all available formatters. Returns: List containing names of all available formatters. Type Array <static> remove(name) Remove formatter with specified name. Parameters: Name Type Description name String Name of formatter. Returns: Function that represents formatter or null if no one of formatters has the specified name. Type function | null <static> set(name, format) Set formatter with specified name. Parameters: Name Type Description name String Name of formatter. format function | null Function that represents formatter. Throws: Will throw an error if format is not a function. Returns: Object that represents module exports. Type Object × Search results Close "},"module-format_util.html":{"id":"module-format_util.html","title":"Module: format/util","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Module: format/util Helper functions for formating. Methods <static> getLicenseList(data) Return list of license types extracted from specified data. License types extracted from license or licenses field. Parameters: Name Type Description data Object Data that should be processed. Returns: List of found license types. Type Array <static> getRepository(data) Return repository URL extracted from specified data. URL extracted from repository field. Parameters: Name Type Description data Object Data that should be processed. Returns: Found repository URL or empty string. Type String × Search results Close "},"module-github.html":{"id":"module-github.html","title":"Module: github","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Module: github Module that provides means to check/search in GitHub. Members <static> settings Supported operation settings/options. Conform to format of nomnom options. Methods <static> detect(name, callback [, settings]) Check whether repository with the specified name is existent. Data about found repositories will be passed into callback as array. If no repository is found, empty array will be passed into callback. Parameters: Name Type Argument Description name String Name of the repository to check. callback function Function that should be called to process operation's result. settings Object <optional> Operation settings. The following settings are supported (name - type - description): caseSensitive - Boolean - Whether case-sensitive search should be used partialMatch - Integer - Allow partial matching: 0 - disallow (by default), 1 - allow at the beginning of matching strings, 2 - allow substring matching lang, language - String - Search repositories that are written in the specified language user - String - GitHub username that should be used for authentication password - String - GitHub account password token - String - OAuth2 token that should be used for authentication instead of username and password limit - Integer - Limit of quantity of results; default and maximum value is 100 pageSize - Integer - Quantity of results per page; default and maximum value is 100 × Search results Close "},"module-grunt.html":{"id":"module-grunt.html","title":"Module: grunt","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Module: grunt Module that provides means to check/search in registry of Grunt plugins. Methods <static> detect(name, callback [, settings]) Check whether plugin with the specified name is existent, or make search for the specified string. Data about found plugins will be passed into callback as array. If no plugin is found, empty array will be passed into callback. Parameters: Name Type Argument Description name String Name of the plugin to check or string to search for. callback function Function that should be called to process operation's result. settings Object <optional> Operation settings. The following settings are supported (name - type - description): caseSensitive - Boolean - Whether case-sensitive check/search should be used partialMatch - Integer - Allow partial matching when checking name: 0 - disallow (by default), 1 - allow at the beginning of matching strings, 2 - allow substring matching search - Boolean - Whether search should be made instead of check limit - Integer - Limit of quantity of results × Search results Close "},"module-gulp.html":{"id":"module-gulp.html","title":"Module: gulp","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Module: gulp Module that provides means to check/search in registry of Gulp plugins. Methods <static> detect(name, callback [, settings]) Check whether plugin with the specified name is existent, or make search for the specified string. Data about found plugins will be passed into callback as array. If no plugin is found, empty array will be passed into callback. Parameters: Name Type Argument Description name String Name of the plugin to check or string to search for. callback function Function that should be called to process operation's result. settings Object <optional> Operation settings. The following settings are supported (name - type - description): caseSensitive - Boolean - Whether case-sensitive check/search should be used partialMatch - Integer - Allow partial matching when checking name: 0 - disallow (by default), 1 - allow at the beginning of matching strings, 2 - allow substring matching search - Boolean - Whether search should be made instead of check limit - Integer - Limit of quantity of results requestTimeout - Integer - Number of milliseconds to wait for a response before aborting a data request <static> preparePlugin(plugin) Convert received plugin's data to normalized form. Parameters: Name Type Description plugin Object Source data. Returns: Normalized data. Type Object × Search results Close "},"module-json.html":{"id":"module-json.html","title":"Module: json","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Module: json Module that provides formatter to convert result of search into JSON. (require(\"json\"))(data, settings) Format/convert result of search into JSON. Parameters: Name Type Description data Object Result of search. settings Object Format settings. See format for details. See: format Returns: JSON representing result of search. Type String × Search results Close "},"module-jster.html":{"id":"module-jster.html","title":"Module: jster","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Module: jster Module that provides means to check/search in JSter. Methods <static> detect(name, callback [, settings]) Check whether library with the specified name is existent, or make search for the specified string. Data about found libraries will be passed into callback as array. If no library is found, empty array will be passed into callback. Parameters: Name Type Argument Description name String Name of the library to check or string to search for. callback function Function that should be called to process operation's result. settings Object <optional> Operation settings. The following settings are supported (name - type - description): caseSensitive - Boolean - Whether case-sensitive check/search should be used partialMatch - Integer - Allow partial matching when checking name: 0 - disallow (by default), 1 - allow at the beginning of matching strings, 2 - allow substring matching search - Boolean - Whether search should be made instead of check limit - Integer - Limit of quantity of results × Search results Close "},"module-markdown.html":{"id":"module-markdown.html","title":"Module: markdown","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Module: markdown Module that provides formatter to convert result of search into Markdown. (require(\"markdown\"))(data, settings) Format/convert result of search into Markdown. Parameters: Name Type Description data Object Result of search. settings Object Format settings. See format for details. See: format Returns: Markdown text representing result of search. Type String × Search results Close "},"module-microjs.html":{"id":"module-microjs.html","title":"Module: microjs","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Module: microjs Module that provides means to check/search in MicroJS. Methods <static> detect(name, callback [, settings]) Check whether library with the specified name is existent, or make search for the specified string. Data about found libraries will be passed into callback as array. If no library is found, empty array will be passed into callback. Parameters: Name Type Argument Description name String Name of the library to check or string to search for. callback function Function that should be called to process operation's result. settings Object <optional> Operation settings. The following settings are supported (name - type - description): caseSensitive - Boolean - Whether case-sensitive check/search should be used partialMatch - Integer - Allow partial matching when checking name: 0 - disallow (by default), 1 - allow at the beginning of matching strings, 2 - allow substring matching search - Boolean - Whether search should be made instead of check limit - Integer - Limit of quantity of results × Search results Close "},"module-npm.html":{"id":"module-npm.html","title":"Module: npm","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Module: npm Module that provides means to check/search in NPM. Methods <static> detect(name, callback [, settings]) Check whether package with the specified name is existent, or make search for the specified string. Data about found packages will be passed into callback as array. If no package is found, empty array will be passed into callback. Parameters: Name Type Argument Description name String Name of the package to check or string to search for. callback function Function that should be called to process operation\"s result. settings Object <optional> Operation settings. The following settings are supported (name - type - description): caseSensitive - Boolean - Whether case-sensitive check/search should be used partialMatch - Integer - Allow partial matching when checking name: 0 - disallow (by default), 1 - allow at the beginning of matching strings, 2 - allow substring matching search - Boolean - Whether search should be made instead of check limit - Integer - Limit of quantity of results × Search results Close "},"module-raw.html":{"id":"module-raw.html","title":"Module: raw","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Module: raw Module that provides formatter to return raw JSON result of search. (require(\"raw\"))(data, settings) Return raw JSON result of search. Parameters: Name Type Description data Object Result of search. settings Object Format settings. See format for details. See: format Returns: JSON representing result of search. Type String × Search results Close "},"module-resource.html":{"id":"module-resource.html","title":"Module: resource","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Module: resource API to work with resources. Methods <static> add(resource) Add data about a resource into the list of available resources. Parameters: Name Type Description resource Object Represents data about a resource that should be added. Object should contain the following fields (name - type - description): name - String - resource name (required) description - String - resource description url - String - URL of resource's site tag - Array of String - tags/keywords of resource note - String - additional information about resource usage module - String - path to the module that should be used to work with resource; the module should implement necessary API api - Object - object that implements necessary API to work with resource The only mandatory field is name. Also module or api field should be specified. See: isAvailable Throws: Will throw an error if resource name is not specified. Will throw an error if resource API object and path to resource module are not specified. Will throw an error if there is a resource with the same name. Returns: Object that represents module exports. Type Object <static> checkResourceTags(resource, tagList [, checkAllTags]) Check resource on presence or absence of specified tags. Parameters: Name Type Argument Description resource Object Represents data about a resource that should be checked. tagList Array List of tags (in lower case) that should be checked on presence or absence in resource tags. Tag in form \"name\" (without quotes; a positive tag) means that resource should be checked on presence of \"name\" tag. Tag in form \"-name\" (without quotes; a negative tag) means that resource should be checked on absence of \"name\" tag. checkAllTags Boolean <optional> Whether all tags specified in tagList should be checked on presence/absence in resource tags. When parameter has true value it means that resource should have all positive tags and should not have any negative tag. When parameter has false value (by default) it means that resource should have one of positive tags and should not have one of negative tags. Returns: true if resource tags satisfy to specified tags (depending on checkAllTags value), false otherwise. Type Boolean <static> filterList( [settings]) Apply filter on list of currently available resources. After operation only resources conforming to filter will be available. In essence, this method is a wrapper for the following code: setList( getList(settings) ) Parameters: Name Type Argument Description settings Object <optional> Specifies which resources should be selected. The following settings can be used to select resources: selectName, selectTag, checkAllTags. See getList for details. See: getList resetList setList Returns: Object that represents module exports. Type Object <static> getAllNameList() Return list that contains names of all available resources. See: getNameList Returns: List that contains names of all available resources. Type Array <static> getIdByName(name) Return identifier of resource with given name. Parameters: Name Type Description name String A resource name (case-insensitive). Returns: Identifier of resource that has the given name or null if no one of available resources has the specified name. Type String | null <static> getList( [settings]) Return list of specified resources. If no selection criteria is set then returns list of all available resources. Parameters: Name Type Argument Description settings Object <optional> Specifies which data items should be returned. The following settings are supported (name - type - description): includeApi - Boolean - whether API object for resource should be included into data item under api field; false by default selectName - Array | String - specifies filter for available resources by name; list of names of resources or name of resource (case-insensitive) that should be included into result selectTag - Array | String - specifies filter for available resources by tag; list of tags or tag (case-insensitive) that should be used to select resources into result; resources that satisfy to specified tags (depending on checkAllTags setting) will be included in result; see checkResourceTags for details checkAllTags - Boolean - whether all tags specified in selectTag should be checked; see checkResourceTags for details Filter by name (selectName) and filter by tag (selectTag) can be used separately or together. If no filter is specified, all resources will be included into result. See: checkResourceTags Returns: List that contains objects presenting data about selected resources. Type Array <static> getMap( [settings]) Return object that represents specified resources. If no selection criteria is set then returns object that contains data about all available resources. Parameters: Name Type Argument Description settings Object <optional> Specifies which data items should be returned. See getList for details. See: getList Returns: Object that contains data about selected resources. Fields are resource keys, values are objects representing data about resources. Type Object <static> getNameList( [settings]) Return list that contains names of selected resources. If no selection criteria is set then returns list of names of all available resources. Parameters: Name Type Argument Description settings Object <optional> Specifies selection criteria. The following settings can be used to select resources: selectName, selectTag, checkAllTags. See getList for details. See: getAllNameList getList Returns: List that contains names of selected resources. Type Array <static> initList(list) Set initial list of all available resources. This list is used to reset to initial state. Parameters: Name Type Description list Array | Object List that contains objects presenting data about resources, or object with data about an resource. See: resetList setList Returns: Object that represents module exports. Type Object <static> isAvailable(name) Check whether there is a resource with given name. Parameters: Name Type Description name String A name that should be checked (case-insensitive). Returns: true if there is a resource with the given name, false if no one of available resources has the specified name. Type Boolean <static> remove(name) Remove resource with given name from list of resources. Parameters: Name Type Description name String Name of resource that should be removed (case-insensitive). Returns: Object that represents removed resource or null if no one of resources from list has the specified name. Type Object | null <static> removeAll() Clear list of resources. See: add Returns: Object that represents module exports. Type Object <static> resetList() Set list of resources to initial state containing data about all available resources. See: setList Returns: Object that represents module exports. Type Object <static> setList(list) Change list of available resources. In essence this method removes all available resources and adds data about each given resource into the list of available resources. Parameters: Name Type Description list Array | Object List that contains objects presenting data about resources, or object with data about an resource. See: add removeAll Returns: Object that represents module exports. Type Object × Search results Close "},"module-resource_util.html":{"id":"module-resource_util.html","title":"Module: resource/util","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Module: resource/util Helper functions. Classes FailedHttpRequestError IncorrectResponseError Methods <static> decodeHtmlEntity(str) Decode HTML entities in given string. Parameters: Name Type Description str String String that should be processed. Returns: Decoded string. Type String <static> getHttpRequestError(err, response) Return object that represents data about error of HTTP request. If err parameter is set then it will be returned. Otherwise instance of FailedHttpRequestError will be returned. Parameters: Name Type Description err Error Represents data about error. response http.IncomingMessage Represents data about response. Returns: Error object. Type Error <static> getLimit( [settings] [, defaultValue] [, maxValue]) Return value of limit setting. Default value will be returned if limit field is not present in settings parameter. Parameters: Name Type Argument Description settings Object <optional> Operation settings. The object can have numeric limit field which value will be returned if the value is positive number and not greater than maximum value. Otherwise value of defaultValue parameter will be returned. defaultValue Number <optional> Default value of limit. maxValue is used when parameter value is not passed or 0. maxValue Number <optional> Maximum value of limit. Number.MAX_VALUE is used when parameter value is not passed. Returns: Value that corresponds to limit setting. Type Number <static> getRequestSettings( [settings] [, json]) Return request settings. Parameters: Name Type Argument Default Description settings Object <optional> Operation settings. The following settings are used to form request settings (name - type - description): requestTimeout - Integer - Number of milliseconds to wait for a response before aborting a data request json Boolean <optional> true Whether the setting to process response as JSON should be added. Returns: Request settings. Type Object <static> isRealSearchSet( [settings]) Determine whether search should be made instead of check according to operation settings. Parameters: Name Type Argument Description settings Object <optional> Operation settings. The following settings are used to specify real search (name - type - description): search - Boolean - Whether search should be made instead of check Returns: true if real search should be made according to settings, false otherwise. Type Boolean <static> isSearchSet( [settings]) Check whether search should be made according to operation settings. Parameters: Name Type Argument Description settings Object <optional> Operation settings. The following settings are used to specify search (name - type - description): caseSensitive - Boolean - Whether case-sensitive check/search should be used partialMatch - Integer - Allow partial matching: 0 - disallow (by default), 1 - allow at the beginning of matching strings, 2 - allow substring matching search - Boolean - Whether search should be made instead of check Returns: true if search should be made according to settings, false otherwise. Type Boolean <static> isStringMatch(value, searchValue [, settings]) Check whether one of given strings is similar to the searched string. Parameters: Name Type Argument Description value Array | String String or array of strings that should be checked. searchValue String Value that is searched for. settings Object <optional> Operation settings. The following settings are supported (name - type - description): caseSensitive - Boolean - Whether case-sensitive check should be used partialMatch - Integer - Allow partial matching: 0 - disallow (by default), 1 - allow at the beginning of matching strings, 2 - allow substring matching search - Boolean - Whether search should be made instead of check Returns: true if one of given strings is similar to the searched string according to settings, false otherwise. Type Boolean × Search results Close "},"module-resource_util-FailedHttpRequestError.html":{"id":"module-resource_util-FailedHttpRequestError.html","title":"Class: FailedHttpRequestError","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Class: FailedHttpRequestError resource/util~ FailedHttpRequestError new FailedHttpRequestError(response [, message]) Class for errors of failed HTTP requests. Parameters: Name Type Argument Description response http.IncomingMessage Represents data about response. message String <optional> Error message. × Search results Close "},"module-resource_util-IncorrectResponseError.html":{"id":"module-resource_util-IncorrectResponseError.html","title":"Class: IncorrectResponseError","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Class: IncorrectResponseError resource/util~ IncorrectResponseError new IncorrectResponseError(responseData [, message]) Class for errors of incorrect response data. Parameters: Name Type Argument Description responseData String Received response data. message String <optional> Error message. × Search results Close "},"module-seeq.html":{"id":"module-seeq.html","title":"Module: seeq","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Module: seeq Detect whether a name is registered or present on some resource, or make search for string on specified resources. Members <static> format Reference to format module. <static> resource Reference to resource module. Methods <static> search(names, callback [, settings]) Check existence of each name from the list on specified resources or search for each string on specified resources. Result of checking/searching will be passed into callback as object. Each field of the object is a name that was checked/searched. Value of result's field is object that is returned by searchName function. null will be passed into callback when no name is specified to check/search. Parameters: Name Type Argument Description names Array | String The list of names or a name that should be checked/searched. callback function Function that should be called to process operation's result. settings Object <optional> Operation settings. See searchName for details. <static> searchName(name, callback [, settings]) Check existence of name or search for given string on specified resources. Result of checking/searching will be passed into callback as object. Each field of the object is name of resource that was checked/searched. Value of result's field is object with the following fields (name - type - description): name - String - resource name description - String - resource description url - String - URL of resource query - String - name/string that was checked/searched result - Array - result that was received from resource; each item in the array is object that represents data about found element error - Object | String - error that was got while checking resource; this field is present only when there was an error null will be passed into callback when the name is not given or resources with specified names are not found. Parameters: Name Type Argument Description name String The name that should be checked/searched. callback function Function that should be called to process operation's result. settings Object <optional> Operation settings. The following settings are supported (name - type - description): progressCallback - Function - function that should be called after getting result from each resource; object with the following fields will be passed into callback: name - String - name that was checked/searched resource - String - resource that was checked result - Object - result of checking/searching (see above) number - Integer - index number of checking/searching total - Integer - total number of checks/searches error - Object | String - error that was got while checking/searching resource; this field is present only when there was an error resource - Array | String - specifies filter for available resources by name; list of names of resources or name of resource (case-insensitive) that should be checked/searched resourceTag - Array | String - specifies filter for available resources by tag; list of tags or tag (case-insensitive) that should be used to select resources; resources that satisfy to specified tags (depending on checkAllTags setting) will be checked/searched; see checkResourceTags for details checkAllTags - Boolean - whether all tags specified in resourceTag should be used to select resources; see checkResourceTags for details search - Boolean - whether search should be made instead of check; it is used only when search setting for a resource is not specified (see below) settings - Object - settings for resources usage; fields are resource identifiers, values are objects representing settings for the corresponding resources; value of _general field can be used to specify settings that should be applied to all resources Filter by name (resource) and filter by tag (resourceTag) can be used separately or together. If no filter is specified, all resources will be checked/searched. × Search results Close "},"module-text.html":{"id":"module-text.html","title":"Module: text","body":" seeq Modules bowercdnjscliformatformat/utilgithubgruntgulpjsonjstermarkdownmicrojsnpmrawresourceresource/utilseeqtextwebcomponents Classes resource/util~FailedHttpRequestErrorresource/util~IncorrectResponseError Module: text Module that provides formatter to convert result of search into plain text. (require(\"text\"))(data, settings) Format/convert result of search into plain text. Parameters: Name Type Description data Object Result of search. settings Object Format settings. See format for details. See: format Returns: Text representing result of search. Type String × Search results Cl