@flex-development/docmark-util-types 1.0.0-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +28 -0
- package/README.md +109 -0
- package/dist/index.d.mts +1957 -0
- package/package.json +58 -0
package/LICENSE.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
BSD 3-Clause License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024, Flex Development, LLC All rights reserved.
|
|
4
|
+
|
|
5
|
+
Redistribution and use in source and binary forms, with or without modification,
|
|
6
|
+
are permitted provided that the following conditions are met:
|
|
7
|
+
|
|
8
|
+
1. Redistributions of source code must retain the above copyright notice, this
|
|
9
|
+
list of conditions and the following disclaimer.
|
|
10
|
+
|
|
11
|
+
2. Redistributions in binary form must reproduce the above copyright notice,
|
|
12
|
+
this list of conditions and the following disclaimer in the documentation
|
|
13
|
+
and/or other materials provided with the distribution.
|
|
14
|
+
|
|
15
|
+
3. Neither the name of the copyright holder nor the names of its contributors
|
|
16
|
+
may be used to endorse or promote products derived from this software without
|
|
17
|
+
specific prior written permission.
|
|
18
|
+
|
|
19
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
20
|
+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
21
|
+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
22
|
+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
|
|
23
|
+
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
24
|
+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
25
|
+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
|
26
|
+
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
27
|
+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
28
|
+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
package/README.md
ADDED
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
# docmark-util-types
|
|
2
|
+
|
|
3
|
+
[](https://github.com/flex-development/docmark-/releases/latest)
|
|
4
|
+
[](https://npmjs.com/package/@flex-development/docmark-util-types)
|
|
5
|
+
[](https://www.npmcharts.com/compare/@flex-development/docmark-util-types?interval=30)
|
|
6
|
+
[](https://packagephobia.now.sh/result?p=@flex-development/docmark-util-types)
|
|
7
|
+
[](https://bundlephobia.com/package/@flex-development/docmark-util-types)
|
|
8
|
+
[](LICENSE.md)
|
|
9
|
+
[](https://typescriptlang.org)
|
|
10
|
+
[](https://yarnpkg.com)
|
|
11
|
+
|
|
12
|
+
[docmark][] utility package with TypeScript types.
|
|
13
|
+
|
|
14
|
+
## Contents
|
|
15
|
+
|
|
16
|
+
- [What is this?](#what-is-this)
|
|
17
|
+
- [When should I use this?](#when-should-i-use-this)
|
|
18
|
+
- [Install](#install)
|
|
19
|
+
- [Use](#use)
|
|
20
|
+
- [API](#api)
|
|
21
|
+
- [Types](#types)
|
|
22
|
+
- [Contribute](#contribute)
|
|
23
|
+
|
|
24
|
+
## What is this?
|
|
25
|
+
|
|
26
|
+
This package exposes TypeScript types shared throughout the docmark ecosystem.
|
|
27
|
+
|
|
28
|
+
## When should I use this?
|
|
29
|
+
|
|
30
|
+
This package is useful when making your own, typed, docmark extensions.
|
|
31
|
+
|
|
32
|
+
## Install
|
|
33
|
+
|
|
34
|
+
This package is [ESM only][esm].
|
|
35
|
+
|
|
36
|
+
In Node.js with [yarn][]:
|
|
37
|
+
|
|
38
|
+
```sh
|
|
39
|
+
yarn add @flex-development/docmark-util-types
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
<blockquote>
|
|
43
|
+
<small>
|
|
44
|
+
See <a href='https://yarnpkg.com/protocol/git'>Git - Protocols | Yarn</a>
|
|
45
|
+
for details regarding installing from Git.
|
|
46
|
+
</small>
|
|
47
|
+
</blockquote>
|
|
48
|
+
|
|
49
|
+
In Deno with [`esm.sh`][esmsh]:
|
|
50
|
+
|
|
51
|
+
```ts
|
|
52
|
+
import type { Construct, /* … */ } from 'https://esm.sh/@flex-development/docmark-util-types'
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Use
|
|
56
|
+
|
|
57
|
+
```ts
|
|
58
|
+
import type { Construct } from '@flex-development/docmark-util-types'
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
```js
|
|
62
|
+
/**
|
|
63
|
+
* @import {Construct} from '@flex-development/docmark-util-types'
|
|
64
|
+
*/
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## API
|
|
68
|
+
|
|
69
|
+
This module exports no identifiers.
|
|
70
|
+
There is no default export.
|
|
71
|
+
|
|
72
|
+
See the [code](./src/index.mts) for all exposed types.
|
|
73
|
+
|
|
74
|
+
## Types
|
|
75
|
+
|
|
76
|
+
This package is fully typed with [TypeScript][].\
|
|
77
|
+
It exports interfaces and types.
|
|
78
|
+
For runtime values, see [`docmark-util-symbol`][docmark-util-symbol].
|
|
79
|
+
|
|
80
|
+
## Project
|
|
81
|
+
|
|
82
|
+
### Version
|
|
83
|
+
|
|
84
|
+
docmark-util-types adheres to [semver][].
|
|
85
|
+
|
|
86
|
+
### Contribute
|
|
87
|
+
|
|
88
|
+
See [`CONTRIBUTING.md`](../../CONTRIBUTING.md).
|
|
89
|
+
|
|
90
|
+
This project has a [code of conduct](../../CODE_OF_CONDUCT.md).
|
|
91
|
+
By interacting with this repository, organization, or community you agree to abide by its terms.
|
|
92
|
+
|
|
93
|
+
### Sponsor
|
|
94
|
+
|
|
95
|
+
Support long-term stability by sponsoring Flex Development!
|
|
96
|
+
|
|
97
|
+
[docmark]: ../../README.md
|
|
98
|
+
|
|
99
|
+
[docmark-util-symbol]: ../docmark-util-symbol/README.md
|
|
100
|
+
|
|
101
|
+
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
|
|
102
|
+
|
|
103
|
+
[esmsh]: https://esm.sh
|
|
104
|
+
|
|
105
|
+
[semver]: https://semver.org
|
|
106
|
+
|
|
107
|
+
[typescript]: https://www.typescriptlang.org
|
|
108
|
+
|
|
109
|
+
[yarn]: https://yarnpkg.com
|