## Background
Want to use `` to display something not just text, but it may be dangerous, XSS.
So i want to see if i can filter what i want from massive string.
## Feature
- match `html elements & it's conent & it's attribute`
- filter `html elements & it's conent & it's attribute`
## Installation
`node.js` could install by this command:
```javascript
npm install vhtml.regexp
```
## API
### match_element()
1. Overview
```javascript
function match_element(string, callback = function (element, tool) {}, regexp = /([^<>]*)(<([^ >]*) ?([^>]*)>)/);
```
2. Arguments
- `string`*string*: input string
- `callback = function (element, tool) {}`*funcion*: callback function
1. `tool.index`*integer*: the index of element
2. `tool.match`*object*: the `return value` of `.match(regexp)`
- `regexp = /([^<>]*)(<([^ >]*) ?([^>]*)>)/`*regexp*: `regexp pattern` catches the elements
Your `regexp pattern` must observe these:
1. `element.content = .match(regexp)[1]`*string*
2. `element.tag = .match(regexp)[2]`*string*
3. `element.type = .match(regexp)[3]`*string*
4. `element.attribute = .match(regexp)[4]`*string*
3. Return
none
### filter_element()
1. Overview
```javascript
function filter_element(string, list = [], config = {});
```
2. Arguments
- `string`*string*: input string
- `list = []`*object[]*: match list
1. `type`*string[]*: type of element, such as `'html'`
2. `content`*string -> regexp*: content of element, such as `/miiwu/`
3. `attribute`*string -> regexp*: content of attribute, such as `/href="https:\/\/localhost"/`
- `config = {}`*object*: optional configurations
1. `allow = true`*boolean*: match mode
- `allow mode`*allow = true*: would `retain` elements match `list`
- `block mode`*allow = false*: would `reject` elements match `list`
2. `callback`*object*: callback function
- `match = function(element) {}`*function*: called when `match`
- `miss = function(element) {}`*function*: called when `miss` or `mismatch`
- `extension = function (element, tool) {}`*function*: called when filter complete
see also `match_element().callback()`
3. `regexp = /([^<>]*)(<([^ >]*) ?([^>]*)>)/`*regexp*: correspond the `regexp` of `match_element()`
3. Return
string filtered through the list
## Idea
- [x] `match_element()` split into `content, tag, type, attribute`
## Resource
- [changelog](../changelog/en.md)
## Gratitude
- [soulsign-chrome](https://github.com/inu1255/soulsign-chrome)：The project let me to start the repo
- [sspanel.sousign](https://github.com/miiwu/sspanel.soulsign)：The project i want to display
## License
[Apache License 2.0](./license)
## Language
- [中文](./zh.md)