TypeScript type guards for `mdast` directive nodes.
npm install @accuser/mdast-util-directive-type-guardsThis package provides TypeScript type guards for Mdast Directive nodes.
``sh`
npm install @accuser/mdast-util-directive-type-guards
`ts
import { isTextDirective } from '@accuser/mdast-util-directive-type-guards';
const node = {
type: 'textDirective',
name: 'foo',
children: [{ type: 'text', value: 'Hello, world!' }]
} as unknown;
if (isTextDirective(node)) {
// node is TextDirective
}
`
This package exports the identifiers:
- isContainerDirective
- isDirectives
- isLeafDirective
- isTextDirective
There is no default export.
Test if a given value is a valid Mdast ContainerDirective node.
###### Parameters
- node (unknown)
- value to check.
###### Returns
Returns true if node is a valid ContainerDirective node.
###### Example
`ts
import { isContainerDirective } from '@accuser/mdast-util-directive-type-guards';
const node = {
type: 'containerDirective',
name: 'foo',
children: [{ type: 'text', value: 'Hello, world!' }]
} as unknown;
if (isContainerDirective(node)) {
console.log(node.name); // 'foo'
console.log(node.children[0]); // { type: 'text', value: 'Hello, world!' }
}
`
Test if a given value is a valid Mdast Directives node.
###### Parameters
- node (unknown)
- value to check.
###### Returns
Returns true if node is a valid Directives node.
###### Example
`ts
import { isDirectives } from '@accuser/mdast-util-directive-type-guards';
const node = {
type: 'containerDirective',
name: 'foo',
children: [{ type: 'text', value: 'Hello, world!' }]
} as unknown;
if (isDirectives(node)) {
console.log(node.name); // 'foo'
console.log(node.children[0]); // { type: 'text', value: 'Hello, world!' }
}
`
Test if a given value is a valid Mdast LeafDirective node.
###### Parameters
- node (unknown)
- value to check.
###### Returns
Returns true if node is a valid LeafDirective node.
###### Example
`ts
import { isLeafDirective } from '@accuser/mdast-util-directive-type-guards';
const node = {
type: 'leafDirective',
name: 'foo',
children: [{ type: 'text', value: 'Hello, world!' }]
} as unknown;
if (isLeafDirective(node)) {
console.log(node.name); // 'foo'
console.log(node.children[0]); // { type: 'text', value: 'Hello, world!' }
}
`
Test if a given value is a valid Mdast TextDirective node.
###### Parameters
- node (unknown)
- value to check.
###### Returns
Returns true if node is a valid TextDirective node.
###### Example
`ts
import { isTextDirective } from '@accuser/mdast-util-directive-type-guards';
const node = {
type: 'textDirective',
name: 'foo',
children: [{ type: 'text', value: 'Hello, world!' }]
} as unknown;
if (isTextDirective(node)) {
console.log(node.name); // 'foo'
console.log(node.children[0]); // { type: 'text', value: 'Hello, world!' }
}
`
`sh``
npm test
[api-iscontainterdirective]: #iscontainerdirectivenode-unknown-node-is-containerdirective
[api-isdirectives]: #isdirectivesnode-unknown-node-is-directives
[api-isleafdirective]: #isleafdirectivenode-unknown-node-is-leafdirective
[api-istextdirective]: #istextdirectivenode-unknown-node-is-textdirective