Skip to content

Latest commit

 

History

History
99 lines (74 loc) · 2.57 KB

README.md

File metadata and controls

99 lines (74 loc) · 2.57 KB
Raw

uninspect

Detect F12 open browser console. protect web site static resources, support redirect, rewrite, custom callback strategies.

Usage

In html:

<head>
  <!-- ... -->
  <script type="module" src="https://cdn.jsdelivr.net/npm/[email protected]/dist/index.mjs"></script>
  <script type="module">
    // custom options
    ConsoleBan.init({
      redirect: '/play/404.html'
    })
  </script>
</head>

Or in bundle project:

npm i uninspect
import { init } from 'uninspect'

init(options)

Strategy

Redirect

ConsoleBan.init({
  // Redirect to /404 relative url
  redirect: '/404',
  // Redirect to absolute url
  redirect: 'http://domain.com/path'
})

Use redirect to guide users to a site introduction page or a purely static 404 page

P.S. In SPA route push scene, detect will not take effect again.

Rewrite

var div = document.createElement('div')
div.innerHTML = 'Stop'

ConsoleBan.init({
  // Rewrite the <body></body> as a string
  write: '<h1> Stop </h1>',
  // or rewrite a element
  write: div
})

Rewriting strategies can completely block web site content, but are less friendly and are not recommended.

Custom callback

ConsoleBan.init({
  callback: () => {
    // ...
  }
})

The callback function supports custom policies after the console is opened.

Options

name required type default description
clear no boolean true Disable console.clear
debug no boolean true Whether to enable infinity debugger
debugTime no number 3000 The debugger execution interval
redirect no string - Redirect url when console is opend
write no string | Element - Rewrite document.body content when console is opend
callback no Function - Custom callback when console is opend
bfcache no boolean true Disable bfcache

P.S. redirect, write, callback only one will work, priority use callback.

Support

browser core support
chrome ✓
firefox ✓
safari ✓