StarMirror/showdown
1
0
Fork 0
mirror of https://github.com/showdownjs/showdown.git synced 2024-03-22 13:30:55 +08:00
Code Issues Projects Releases Wiki Activity

docs(events): fix typo in properties

Browse Source
This commit is contained in:
Estevão Soares dos Santos 2022-03-20 15:34:16 +00:00 committed by GitHub
parent 4f0f76ca76
commit 6397c203f6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/event_system.md
View File

@ -24,7 +24,7 @@ Each subparser raises several events sequentially:
|----------|-----------|------------|--------------------------------------------------------------------|
| input | string | read | The full text that was passed to the subparser |
| output | string | write | The full text with modification that will be passed along the chain|
| regex | null | | |
| regexp | null | | |
| matches | null | | |
Usually you would want to use this event if you wish to change the input to the subparser
@ -42,7 +42,7 @@ Each subparser raises several events sequentially:
|----------|-----------|------------|--------------------------------------------------------------------|
| input | string | read | The captured text |
| output | string | write | The text that will be passed to the subparser/other listeners |
| regex | RegExp | readonly | Regular Expression used to capture groups |
| regexp | RegExp | readonly | Regular Expression used to capture groups |
| matches | object | read/write | Matches groups. Changes to this object are reflected in the output |
Usually you would want to use this event if you wish to modify a certain subparser behavior.
@ -60,7 +60,7 @@ Each subparser raises several events sequentially:
|------------|-----------|------------|--------------------------------------------------------------------------------|
| input | string | read | The captured text |
| output | string | write | The text that will be passed to the subparser/other listeners |
| regex | RegExp | readonly | Regular Expression used to capture groups |
| regexp | RegExp | readonly | Regular Expression used to capture groups |
| matches | object | read/write | Keypairs of matches groups. Changes to this object are reflected in the output |
| attributes | object | read/write | Attributes to add to the HTML output |
@ -76,7 +76,7 @@ Each subparser raises several events sequentially:
|----------|------------|------------|--------------------------------------------------------------------|
| input | string | read | The captured text |
| output | string | write | The text that will be passed to the subparser/other listeners |
| regex | null | | |
| regexp | null | | |
| matches | null | | |
Usually you would want to use this event if you wish change the subparser output before it is hashed
@ -93,7 +93,7 @@ Each subparser raises several events sequentially:
|----------|-----------|------------|--------------------------------------------------------------------|
| input | string | read | The partial/full text with the subparser modifications |
| output | string | write | The text that will be passed to other subparsers |
| regex | null | | |
| regexp | null | | |
| matches | null | | |
Usually you would want to use this event if you wish change the subparser hashed output
@ -115,7 +115,7 @@ These events are always guaranteed to be called, regardless of options or circum
|----------|-----------|------------|--------------------------------------------------------------------|
| input | string | read | The full text that was passed to the subparser |
| output | string | write | The full text with modification that will be passed along the chain|
| regex | null | | |
| regexp | null | | |
| matches | null | | |
2. **.after**.{subparserName}: *always runs*;
@ -128,7 +128,7 @@ These events are always guaranteed to be called, regardless of options or circum
|----------|-----------|------------|--------------------------------------------------------------------|
| input | string | read | The partial/full text with the subparser modifications |
| output | string | write | The text that will be passed to other subparsers |
| regex | null | | |
| regexp | null | | |
| matches | null | | |