api documentation for lighthouse (v1.6.3)

Lighthouse

table of contents

  1. module lighthouse
    1. function lighthouse (url, flags = {}, configJSON)
    2. function lighthouse.Audit ()
    3. function lighthouse.Gatherer ()
    4. function lighthouse.console_quieter (opts)
    5. function lighthouse.getAuditList ()
    6. function lighthouse.url_shim (url)
    7. object lighthouse.ask
    8. object lighthouse.bin
    9. object lighthouse.chrome_finder
    10. object lighthouse.chrome_launcher
    11. object lighthouse.commands
    12. object lighthouse.emulation
    13. object lighthouse.event_helpers
    14. object lighthouse.file_namer
    15. object lighthouse.handlebar_helpers
    16. object lighthouse.icons
    17. object lighthouse.list_audits
    18. object lighthouse.list_trace_categories
    19. object lighthouse.printer
    20. object lighthouse.random_port
    21. object lighthouse.server
    22. object lighthouse.styles_helpers
    23. object lighthouse.traceCategories
    24. object lighthouse.url_shim.prototype
    25. object lighthouse.web_inspector
  2. module lighthouse.ask
    1. function lighthouse.ask (question, options)
  3. module lighthouse.bin
    1. function lighthouse.bin.run ()
    2. function lighthouse.bin.runLighthouse (url, flags, config)
  4. module lighthouse.chrome_finder
    1. function lighthouse.chrome_finder.darwin ()
    2. function lighthouse.chrome_finder.linux ()
    3. function lighthouse.chrome_finder.win32 ()
  5. module lighthouse.chrome_launcher
    1. function lighthouse.chrome_launcher.ChromeLauncher (opts)
  6. module lighthouse.commands
    1. function lighthouse.commands.ListAudits ()
    2. function lighthouse.commands.ListTraceCategories ()
  7. module lighthouse.console_quieter
    1. function lighthouse.console_quieter (opts)
    2. function lighthouse.console_quieter._consoleerror ()
    3. function lighthouse.console_quieter._consolelog ()
    4. function lighthouse.console_quieter._consolewarn ()
  8. module lighthouse.emulation
    1. function lighthouse.emulation.disableCPUThrottling (driver)
    2. function lighthouse.emulation.disableNetworkThrottling (driver)
    3. function lighthouse.emulation.enableCPUThrottling (driver)
    4. function lighthouse.emulation.enableNetworkThrottling (driver)
    5. function lighthouse.emulation.enableNexus5X (driver)
    6. function lighthouse.emulation.getEmulationDesc ()
    7. function lighthouse.emulation.goOffline (driver)
  9. module lighthouse.event_helpers
    1. function lighthouse.event_helpers.addFormattedCodeSnippet (listener)
    2. function lighthouse.event_helpers.groupCodeSnippetsByLocation (listeners)
  10. module lighthouse.file_namer
    1. function lighthouse.file_namer.getFilenamePrefix (results)
  11. module lighthouse.handlebar_helpers
    1. function lighthouse.handlebar_helpers.and (...args)
    2. function lighthouse.handlebar_helpers.decimal (number && number.toFixed)
    3. function lighthouse.handlebar_helpers.formatDateTime ('en-US', options)
    4. function lighthouse.handlebar_helpers.getAggregationScoreRating (Math.round(score * 100)
    5. function lighthouse.handlebar_helpers.getItemRating (value)
    6. function lighthouse.handlebar_helpers.getScoreBadIcon (informative, additional)
    7. function lighthouse.handlebar_helpers.getScoreGoodIcon {{signature}}
    8. function lighthouse.handlebar_helpers.getTotalScore (aggregation)
    9. function lighthouse.handlebar_helpers.getTotalScoreRating (aggregation)
    10. function lighthouse.handlebar_helpers.ifEq (lhs, rhs, options)
    11. function lighthouse.handlebar_helpers.ifNotEq (lhs, rhs, options)
    12. function lighthouse.handlebar_helpers.isBool (typeof value === 'boolean')
    13. function lighthouse.handlebar_helpers.kebabCase (str || '')
    14. function lighthouse.handlebar_helpers.nameToLink ()
    15. function lighthouse.handlebar_helpers.not {{signature}}
    16. function lighthouse.handlebar_helpers.sanitize (str, opts)
    17. function lighthouse.handlebar_helpers.shouldShowHelpText (getItemRating(value)
  12. module lighthouse.icons
    1. function lighthouse.icons.doExist (manifest)
    2. function lighthouse.icons.sizeAtLeast (sizeRequirement, manifest)
  13. module lighthouse.list_audits
    1. function lighthouse.list_audits.default ()
  14. module lighthouse.list_trace_categories
    1. function lighthouse.list_trace_categories.default ()
  15. module lighthouse.printer
    1. function lighthouse.printer.GetValidOutputOptions ()
    2. function lighthouse.printer.checkOutputPath (path)
    3. function lighthouse.printer.createOutput (results, outputMode)
    4. function lighthouse.printer.write (results, mode, path)
    5. object lighthouse.printer.OutputMode
  16. module lighthouse.random_port
    1. function lighthouse.random_port.getRandomPort ()
  17. module lighthouse.server
    1. function lighthouse.server.hostExperiment (params, results)
  18. module lighthouse.styles_helpers
    1. function lighthouse.styles_helpers.addVendorPrefixes (propsNames)
    2. function lighthouse.styles_helpers.filterStylesheetsByUsage (stylesheets, propName, propVal)
    3. function lighthouse.styles_helpers.getFormattedStyleRule (content, parsedContent)
  19. module lighthouse.url_shim
    1. function lighthouse.url_shim (url)
    2. function lighthouse.url_shim.equalWithExcludedFragments (url1, url2)
    3. function lighthouse.url_shim.getDisplayName (url, options)
    4. function lighthouse.url_shim.hostsMatch (urlA, urlB)
    5. function lighthouse.url_shim.isValid (url)
    6. string lighthouse.url_shim.INVALID_URL_DEBUG_STRING
  20. module lighthouse.url_shim.prototype
    1. function lighthouse.url_shim.prototype.toString ()
  21. module lighthouse.web_inspector
    1. function lighthouse.web_inspector.AgentLayer (target, layerPayload)
    2. function lighthouse.web_inspector.AgentLayerTree (target)
    3. function lighthouse.web_inspector.AggregatedTimelineTreeView (model, filters)
    4. function lighthouse.web_inspector.BackingStorage ()
    5. function lighthouse.web_inspector.BottomUpTimelineTreeView (model, filters)
    6. function lighthouse.web_inspector.CPUProfileDataModel (profile)
    7. function lighthouse.web_inspector.CPUProfileNode (node, sampleTime)
    8. function lighthouse.web_inspector.CallTreeTimelineTreeView (model, filters)
    9. function lighthouse.web_inspector.Color (rgba, format, originalText)
    10. function lighthouse.web_inspector.ConsoleMessage ()
    11. function lighthouse.web_inspector.DeferredLayerTree (target)
    12. function lighthouse.web_inspector.DeferredTempFile ()
    13. function lighthouse.web_inspector.DeferredTracingLayerTree (snapshot, target)
    14. function lighthouse.web_inspector.Event (target, type, data)
    15. function lighthouse.web_inspector.EventTarget ()
    16. function lighthouse.web_inspector.EventsTimelineTreeView (model, filters, delegate)
    17. function lighthouse.web_inspector.ExcludeTopLevelFilter ()
    18. function lighthouse.web_inspector.ExclusiveNameFilter (excludeNames)
    19. function lighthouse.web_inspector.FilmStripModel (tracingModel, zeroTime)
    20. function lighthouse.web_inspector.HBox ()
    21. function lighthouse.web_inspector.InvalidationTracker ()
    22. function lighthouse.web_inspector.InvalidationTrackingEvent (event)
    23. function lighthouse.web_inspector.Layer ()
    24. function lighthouse.web_inspector.LayerPaintEvent (event, target)
    25. function lighthouse.web_inspector.LayerTreeBase (target)
    26. function lighthouse.web_inspector.LayerTreeDispatcher (layerTreeModel)
    27. function lighthouse.web_inspector.LayerTreeModel (target)
    28. function lighthouse.web_inspector.MultitargetNetworkManager ()
    29. function lighthouse.web_inspector.NetworkDispatcher (manager)
    30. function lighthouse.web_inspector.NetworkLog (target)
    31. function lighthouse.web_inspector.NetworkManager (target)
    32. function lighthouse.web_inspector.NetworkRequest (target, requestId, url, documentURL, frameId, loaderId, initiator)
    33. function lighthouse.web_inspector.Object ()
    34. function lighthouse.web_inspector.ParsedURL (url)
    35. function lighthouse.web_inspector.PendingFrame (triggerTime, timeByCategory)
    36. function lighthouse.web_inspector.ProfileNode (callFrame)
    37. function lighthouse.web_inspector.ProfileTreeModel (root)
    38. function lighthouse.web_inspector.ResourceCategory (title, shortTitle)
    39. function lighthouse.web_inspector.ResourceType (name, title, category, isTextType)
    40. function lighthouse.web_inspector.SCSSParser ()
    41. function lighthouse.web_inspector.SDKModel (modelClass, target)
    42. function lighthouse.web_inspector.SDKObject (target)
    43. function lighthouse.web_inspector.Segment (begin, end, data)
    44. function lighthouse.web_inspector.SegmentedRange (mergeCallback)
    45. function lighthouse.web_inspector.SortableDataGrid (columnsArray, editCallback, deleteCallback, refreshCallback, contextMenuCallback)
    46. function lighthouse.web_inspector.SortableDataGridNode (data, hasChildren)
    47. function lighthouse.web_inspector.SourceEdit (sourceURL, oldRange, newText)
    48. function lighthouse.web_inspector.SourceRange (offset, length)
    49. function lighthouse.web_inspector.Target (targetManager, name, capabilitiesMask, connection, parentTarget)
    50. function lighthouse.web_inspector.TargetManager ()
    51. function lighthouse.web_inspector.TempFile ()
    52. function lighthouse.web_inspector.TempFileBackingStorage (dirName)
    53. function lighthouse.web_inspector.TextRange (startLine, startColumn, endLine, endColumn)
    54. function lighthouse.web_inspector.TimelineAggregator (titleMapper, categoryMapper)
    55. function lighthouse.web_inspector.TimelineAsyncEventTracker ()
    56. function lighthouse.web_inspector.TimelineCategory (name, title, visible, childColor, color)
    57. function lighthouse.web_inspector.TimelineDetailsContentHelper (target, linkifier)
    58. function lighthouse.web_inspector.TimelineFrame (startTime, startTimeOffset)
    59. function lighthouse.web_inspector.TimelineFrameModel (categoryMapper)
    60. function lighthouse.web_inspector.TimelineIRModel ()
    61. function lighthouse.web_inspector.TimelineModel (eventFilter)
    62. function lighthouse.web_inspector.TimelinePopupContentHelper (title)
    63. function lighthouse.web_inspector.TimelineRecordStyle (title, category, hidden)
    64. function lighthouse.web_inspector.TimelineStackView (treeView)
    65. function lighthouse.web_inspector.TimelineTreeView (model, filters)
    66. function lighthouse.web_inspector.TimelineUIUtils ()
    67. function lighthouse.web_inspector.TimelineVisibleEventsFilter (visibleTypes)
    68. function lighthouse.web_inspector.TracingLayer (payload)
    69. function lighthouse.web_inspector.TracingLayerTree (target)
    70. function lighthouse.web_inspector.TracingModel (backingStorage)
    71. function lighthouse.web_inspector.UIString (string, vararg)
    72. function lighthouse.web_inspector.UIStringFormat (format)
    73. function lighthouse.web_inspector.VBox ()
    74. function lighthouse.web_inspector.ViewportDataGrid ()
    75. function lighthouse.web_inspector.ViewportDataGridNode ()
    76. function lighthouse.web_inspector.localize (string)
    77. function lighthouse.web_inspector.moduleSetting (settingName)
    78. function lighthouse.web_inspector.setLocalizationPlatform (platform)
    79. object lighthouse.web_inspector.TimelineJSProfileProcessor
    80. object lighthouse.web_inspector.TimelineProfileTree
    81. object lighthouse.web_inspector._moduleSettings
    82. object lighthouse.web_inspector.console
    83. object lighthouse.web_inspector.resourceCategories
    84. object lighthouse.web_inspector.resourceTypes
    85. object lighthouse.web_inspector.settings
    86. object lighthouse.web_inspector.targetManager

module lighthouse

function lighthouse (url, flags = {}, configJSON)

function lighthouse.Audit ()

function lighthouse.Gatherer ()

function lighthouse.console_quieter (opts)

function lighthouse.getAuditList ()

function lighthouse.url_shim (url)

module lighthouse.ask

function lighthouse.ask (question, options)

module lighthouse.bin

function lighthouse.bin.run ()

function lighthouse.bin.runLighthouse (url, flags, config)

module lighthouse.chrome_finder

function lighthouse.chrome_finder.darwin ()

function lighthouse.chrome_finder.linux ()

function lighthouse.chrome_finder.win32 ()

module lighthouse.chrome_launcher

function lighthouse.chrome_launcher.ChromeLauncher (opts)

module lighthouse.commands

function lighthouse.commands.ListAudits ()

function lighthouse.commands.ListTraceCategories ()

module lighthouse.console_quieter

function lighthouse.console_quieter (opts)

function lighthouse.console_quieter._consoleerror ()

function lighthouse.console_quieter._consolelog ()

function lighthouse.console_quieter._consolewarn ()

module lighthouse.emulation

function lighthouse.emulation.disableCPUThrottling (driver)

function lighthouse.emulation.disableNetworkThrottling (driver)

function lighthouse.emulation.enableCPUThrottling (driver)

function lighthouse.emulation.enableNetworkThrottling (driver)

function lighthouse.emulation.enableNexus5X (driver)

function lighthouse.emulation.getEmulationDesc ()

function lighthouse.emulation.goOffline (driver)

module lighthouse.event_helpers

function lighthouse.event_helpers.addFormattedCodeSnippet (listener)

function lighthouse.event_helpers.groupCodeSnippetsByLocation (listeners)

module lighthouse.file_namer

function lighthouse.file_namer.getFilenamePrefix (results)

module lighthouse.handlebar_helpers

function lighthouse.handlebar_helpers.and (...args)

function lighthouse.handlebar_helpers.decimal (number && number.toFixed)

function lighthouse.handlebar_helpers.formatDateTime ('en-US', options)

function lighthouse.handlebar_helpers.getAggregationScoreRating (Math.round(score * 100)

function lighthouse.handlebar_helpers.getItemRating (value)

function lighthouse.handlebar_helpers.getScoreBadIcon (informative, additional)

function lighthouse.handlebar_helpers.getScoreGoodIcon {{signature}}

function lighthouse.handlebar_helpers.getTotalScore (aggregation)

function lighthouse.handlebar_helpers.getTotalScoreRating (aggregation)

function lighthouse.handlebar_helpers.ifEq (lhs, rhs, options)

function lighthouse.handlebar_helpers.ifNotEq (lhs, rhs, options)

function lighthouse.handlebar_helpers.isBool (typeof value === 'boolean')

function lighthouse.handlebar_helpers.kebabCase (str || '')

function lighthouse.handlebar_helpers.nameToLink ()

function lighthouse.handlebar_helpers.not {{signature}}

function lighthouse.handlebar_helpers.sanitize (str, opts)

function lighthouse.handlebar_helpers.shouldShowHelpText (getItemRating(value)

module lighthouse.icons

function lighthouse.icons.doExist (manifest)

function lighthouse.icons.sizeAtLeast (sizeRequirement, manifest)

module lighthouse.list_audits

function lighthouse.list_audits.default ()

module lighthouse.list_trace_categories

function lighthouse.list_trace_categories.default ()

module lighthouse.printer

function lighthouse.printer.GetValidOutputOptions ()

function lighthouse.printer.checkOutputPath (path)

function lighthouse.printer.createOutput (results, outputMode)

function lighthouse.printer.write (results, mode, path)

module lighthouse.random_port

function lighthouse.random_port.getRandomPort ()

module lighthouse.server

function lighthouse.server.hostExperiment (params, results)

module lighthouse.styles_helpers

function lighthouse.styles_helpers.addVendorPrefixes (propsNames)

function lighthouse.styles_helpers.filterStylesheetsByUsage (stylesheets, propName, propVal)

function lighthouse.styles_helpers.getFormattedStyleRule (content, parsedContent)

module lighthouse.url_shim

function lighthouse.url_shim (url)

function lighthouse.url_shim.equalWithExcludedFragments (url1, url2)

function lighthouse.url_shim.getDisplayName (url, options)

function lighthouse.url_shim.hostsMatch (urlA, urlB)

function lighthouse.url_shim.isValid (url)

module lighthouse.url_shim.prototype

function lighthouse.url_shim.prototype.toString ()

module lighthouse.web_inspector

function lighthouse.web_inspector.AgentLayer (target, layerPayload)

function lighthouse.web_inspector.AgentLayerTree (target)

function lighthouse.web_inspector.AggregatedTimelineTreeView (model, filters)

function lighthouse.web_inspector.BackingStorage ()

function lighthouse.web_inspector.BottomUpTimelineTreeView (model, filters)

function lighthouse.web_inspector.CPUProfileDataModel (profile)

function lighthouse.web_inspector.CPUProfileNode (node, sampleTime)

function lighthouse.web_inspector.CallTreeTimelineTreeView (model, filters)

function lighthouse.web_inspector.Color (rgba, format, originalText)

function lighthouse.web_inspector.ConsoleMessage ()

function lighthouse.web_inspector.DeferredLayerTree (target)

function lighthouse.web_inspector.DeferredTempFile ()

function lighthouse.web_inspector.DeferredTracingLayerTree (snapshot, target)

function lighthouse.web_inspector.Event (target, type, data)

function lighthouse.web_inspector.EventTarget ()

function lighthouse.web_inspector.EventsTimelineTreeView (model, filters, delegate)

function lighthouse.web_inspector.ExcludeTopLevelFilter ()

function lighthouse.web_inspector.ExclusiveNameFilter (excludeNames)

function lighthouse.web_inspector.FilmStripModel (tracingModel, zeroTime)

function lighthouse.web_inspector.HBox ()

function lighthouse.web_inspector.InvalidationTracker ()

function lighthouse.web_inspector.InvalidationTrackingEvent (event)

function lighthouse.web_inspector.Layer ()

function lighthouse.web_inspector.LayerPaintEvent (event, target)

function lighthouse.web_inspector.LayerTreeBase (target)

function lighthouse.web_inspector.LayerTreeDispatcher (layerTreeModel)

function lighthouse.web_inspector.LayerTreeModel (target)

function lighthouse.web_inspector.MultitargetNetworkManager ()

function lighthouse.web_inspector.NetworkDispatcher (manager)

function lighthouse.web_inspector.NetworkLog (target)

function lighthouse.web_inspector.NetworkManager (target)

function lighthouse.web_inspector.NetworkRequest (target, requestId, url, documentURL, frameId, loaderId, initiator)

function lighthouse.web_inspector.Object ()

function lighthouse.web_inspector.ParsedURL (url)

function lighthouse.web_inspector.PendingFrame (triggerTime, timeByCategory)

function lighthouse.web_inspector.ProfileNode (callFrame)

function lighthouse.web_inspector.ProfileTreeModel (root)

function lighthouse.web_inspector.ResourceCategory (title, shortTitle)

function lighthouse.web_inspector.ResourceType (name, title, category, isTextType)

function lighthouse.web_inspector.SCSSParser ()

function lighthouse.web_inspector.SDKModel (modelClass, target)

function lighthouse.web_inspector.SDKObject (target)

function lighthouse.web_inspector.Segment (begin, end, data)

function lighthouse.web_inspector.SegmentedRange (mergeCallback)

function lighthouse.web_inspector.SortableDataGrid (columnsArray, editCallback, deleteCallback, refreshCallback, contextMenuCallback)

function lighthouse.web_inspector.SortableDataGridNode (data, hasChildren)

function lighthouse.web_inspector.SourceEdit (sourceURL, oldRange, newText)

function lighthouse.web_inspector.SourceRange (offset, length)

function lighthouse.web_inspector.Target (targetManager, name, capabilitiesMask, connection, parentTarget)

function lighthouse.web_inspector.TargetManager ()

function lighthouse.web_inspector.TempFile ()

function lighthouse.web_inspector.TempFileBackingStorage (dirName)

function lighthouse.web_inspector.TextRange (startLine, startColumn, endLine, endColumn)

function lighthouse.web_inspector.TimelineAggregator (titleMapper, categoryMapper)

function lighthouse.web_inspector.TimelineAsyncEventTracker ()

function lighthouse.web_inspector.TimelineCategory (name, title, visible, childColor, color)

function lighthouse.web_inspector.TimelineDetailsContentHelper (target, linkifier)

function lighthouse.web_inspector.TimelineFrame (startTime, startTimeOffset)

function lighthouse.web_inspector.TimelineFrameModel (categoryMapper)

function lighthouse.web_inspector.TimelineIRModel ()

function lighthouse.web_inspector.TimelineModel (eventFilter)

function lighthouse.web_inspector.TimelinePopupContentHelper (title)

function lighthouse.web_inspector.TimelineRecordStyle (title, category, hidden)

function lighthouse.web_inspector.TimelineStackView (treeView)

function lighthouse.web_inspector.TimelineTreeView (model, filters)

function lighthouse.web_inspector.TimelineUIUtils ()

function lighthouse.web_inspector.TimelineVisibleEventsFilter (visibleTypes)

function lighthouse.web_inspector.TracingLayer (payload)

function lighthouse.web_inspector.TracingLayerTree (target)

function lighthouse.web_inspector.TracingModel (backingStorage)

function lighthouse.web_inspector.UIString (string, vararg)

function lighthouse.web_inspector.UIStringFormat (format)

function lighthouse.web_inspector.VBox ()

function lighthouse.web_inspector.ViewportDataGrid ()

function lighthouse.web_inspector.ViewportDataGridNode ()

function lighthouse.web_inspector.localize (string)

function lighthouse.web_inspector.moduleSetting (settingName)

function lighthouse.web_inspector.setLocalizationPlatform (platform)

[ this document was created with utility2 ]