console-ban's Introduction

console-ban

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

Language: English|中文|日本語

Usage

In html:

<head>
  <!-- ... -->
  <script src="https://cdn.jsdelivr.net/gh/fz6m/[email protected]/dist/console-ban.min.js"></script>
  <script>
    // default options
    ConsoleBan.init()
    // custom options
    ConsoleBan.init({
      redirect: '/404'
    })
  </script>
</head>

Or in bundle project:

  yarn add console-ban

import { init } from 'console-ban'

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