@unlighthouse/core

The core engine of Unlighthouse that handles website scanning, Lighthouse execution, and report generation.

Usage

$3

``ts
import { createUnlighthouse } from '@unlighthouse/core'

const unlighthouse = await createUnlighthouse({
site: 'https://example.com',
debug: true,
scanner: {
device: 'desktop',
}
})

await unlighthouse.start()
`

$3

`ts
import { createUnlighthouse } from '@unlighthouse/core'

const unlighthouse = await createUnlighthouse(
{ / user config / },
{
name: 'custom',
routeDefinitions: () => generateRouteDefinitions(),
}
)
`

$3

`ts
import { useUnlighthouse } from '@unlighthouse/core'

const { hooks } = useUnlighthouse()

hooks.hook('task-complete', (path, response) => {
console.log('Task completed for:', path)
})
`

API

- createUnlighthouse(userConfig, provider?) - Initialize Unlighthouse
- useUnlighthouse() - Access the global Unlighthouse context
- generateClient(options)` - Generate static client files

Documentation

- API Reference
- Configuration Guide
- Puppeteer Configuration

License

MIT License © 2021-PRESENT Harlan Wilton