api documentation for retire (v1.2.12)

Retire is a tool for detecting use of vulnerable libraries

table of contents

  1. module retire
    1. function retire.check (component, version, repo)
    2. function retire.isVulnerable (results)
    3. function retire.replaceVersion (jsRepoJsonAsText)
    4. function retire.scanFileContent (content, repo, hasher)
    5. function retire.scanFileName (fileName, repo)
    6. function retire.scanNodeDependency (dependency, npmrepo)
    7. function retire.scanUri (uri, repo)
    8. object retire
    9. object retire.repo
    10. object retire.resolve
    11. object retire.scanner
    12. object retire.utils
    13. string retire.version
  2. module retire.repo
    1. function retire.repo.loadrepository (repoUrl, options)
    2. function retire.repo.loadrepositoryFromFile (filepath, options)
  3. module retire.resolve
    1. function retire.resolve.getNodeDependencies (path, limit)
    2. function retire.resolve.scanJsFiles (path)
  4. module retire.retire
    1. function retire.retire.check (component, version, repo)
    2. function retire.retire.isVulnerable (results)
    3. function retire.retire.replaceVersion (jsRepoJsonAsText)
    4. function retire.retire.scanFileContent (content, repo, hasher)
    5. function retire.retire.scanFileName (fileName, repo)
    6. function retire.retire.scanNodeDependency (dependency, npmrepo)
    7. function retire.retire.scanUri (uri, repo)
    8. string retire.retire.version
  5. module retire.scanner
    1. function retire.scanner.on (name, listener)
    2. function retire.scanner.scanBowerFile (file, repo, options)
    3. function retire.scanner.scanDependencies (dependencies, nodeRepo, options)
    4. function retire.scanner.scanJsFile (file, repo, options)
  6. module retire.utils
    1. function retire.utils.detect (ar, fn)
    2. function retire.utils.every (things, predicate)
    3. function retire.utils.extend (o, a)
    4. function retire.utils.find (ar, fn)
    5. function retire.utils.flatten (e)
    6. function retire.utils.forwardEvent (emitter, event)
    7. function retire.utils.log (options)
    8. function retire.utils.map (o, fn)
    9. function retire.utils.pick (p, keys)

module retire

function retire.check (component, version, repo)

function retire.isVulnerable (results)

function retire.replaceVersion (jsRepoJsonAsText)

function retire.scanFileContent (content, repo, hasher)

function retire.scanFileName (fileName, repo)

function retire.scanNodeDependency (dependency, npmrepo)

function retire.scanUri (uri, repo)

module retire.repo

function retire.repo.loadrepository (repoUrl, options)

function retire.repo.loadrepositoryFromFile (filepath, options)

module retire.resolve

function retire.resolve.getNodeDependencies (path, limit)

function retire.resolve.scanJsFiles (path)

module retire.retire

function retire.retire.check (component, version, repo)

function retire.retire.isVulnerable (results)

function retire.retire.replaceVersion (jsRepoJsonAsText)

function retire.retire.scanFileContent (content, repo, hasher)

function retire.retire.scanFileName (fileName, repo)

function retire.retire.scanNodeDependency (dependency, npmrepo)

function retire.retire.scanUri (uri, repo)

module retire.scanner

function retire.scanner.on (name, listener)

function retire.scanner.scanBowerFile (file, repo, options)

function retire.scanner.scanDependencies (dependencies, nodeRepo, options)

function retire.scanner.scanJsFile (file, repo, options)

module retire.utils

function retire.utils.detect (ar, fn)

function retire.utils.every (things, predicate)

function retire.utils.extend (o, a)

function retire.utils.find (ar, fn)

function retire.utils.flatten (e)

function retire.utils.forwardEvent (emitter, event)

function retire.utils.log (options)

function retire.utils.map (o, fn)

function retire.utils.pick (p, keys)

[ this document was created with utility2 ]