Comparing version 2.2.1 to 2.3.0
@@ -5,2 +5,3 @@ export namespace lowlight { | ||
export {registerLanguage} | ||
export {registered} | ||
export {listLanguages} | ||
@@ -79,2 +80,9 @@ export {registerAlias} | ||
/** | ||
* Is an alias or language name registered. | ||
* | ||
* @param {string} aliasOrLanguage alias or language | ||
* @returns {boolean} | ||
*/ | ||
declare function registered(aliasOrLanguage: string): boolean | ||
/** | ||
* Get a list of all registered languages. | ||
@@ -81,0 +89,0 @@ * |
@@ -137,2 +137,12 @@ /** | ||
/** | ||
* Is an alias or language name registered. | ||
* | ||
* @param {string} aliasOrLanguage alias or language | ||
* @returns {boolean} | ||
*/ | ||
function registered(aliasOrLanguage) { | ||
return Boolean(high.getLanguage(aliasOrLanguage)) | ||
} | ||
const registerAlias = | ||
@@ -281,4 +291,5 @@ /** | ||
registerLanguage, | ||
registered, | ||
listLanguages, | ||
registerAlias | ||
} |
{ | ||
"name": "lowlight", | ||
"version": "2.2.1", | ||
"version": "2.3.0", | ||
"description": "Virtual syntax highlighting for virtual DOMs and non-HTML things", | ||
@@ -5,0 +5,0 @@ "license": "MIT", |
@@ -35,2 +35,3 @@ # lowlight | ||
* [`lowlight.registerAlias(language, alias)`](#lowlightregisteraliaslanguage-alias) | ||
* [`lowlight.registered(aliasOrlanguage)`](#lowlightregisteredaliasorlanguage) | ||
* [`lowlight.listLanguages()`](#lowlightlistlanguages) | ||
@@ -245,2 +246,29 @@ * [Syntaxes](#syntaxes) | ||
### `lowlight.registered(aliasOrlanguage)` | ||
Is an `alias` or `language` registered. | ||
###### Parameters | ||
* `aliasOrlanguage` (`string`) — [Name][names] of a registered language | ||
or its alias | ||
###### Returns | ||
`boolean`. | ||
###### Example | ||
```js | ||
import {lowlight} from 'lowlight/lib/core.js' | ||
import javascript from 'highlight.js/lib/languages/javascript.js' | ||
lowlight.registerLanguage('javascript', javascript) | ||
lowlight.registered('js') // return false | ||
lowlight.registerAlias('javascript', 'js') | ||
lowlight.registered('js') // return true | ||
``` | ||
### `lowlight.listLanguages()` | ||
@@ -247,0 +275,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
48340
741
571