Skip to content

Commit f4ef74e

Browse files
authored
Merge pull request #55 from takker99:jsdoc
docs: Add module docs
2 parents ac60a34 + 4669839 commit f4ef74e

File tree

4 files changed

+11
-6
lines changed

4 files changed

+11
-6
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
## @cosense/types
22

3+
[![JSR](https://jsr.io/badges/@cosense/types)](https://jsr.io/@cosense/types)
4+
[![test](https://github.com/scrapbox-jp/types/workflows/ci/badge.svg)](https://github.com/scrapbox-jp/types/actions?query=workflow%3Aci)
5+
36
Type definitions for [cosense](https://cosen.se)
47

58
## Getting Started

mod.ts

Lines changed: 0 additions & 3 deletions
This file was deleted.

rest.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
/** @module types used at REST API */
1+
/** type definitions for Cosense REST API responses
2+
*
3+
* @module
4+
*/
25

36
export * from "./base.ts";
47
export * from "./commit.ts";

userscript.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
/** @module types used at UserScript */
2-
1+
/** type definitions for Cosense UserScript
2+
*
3+
* @module
4+
*/
35
export * from "./base.ts";
46
export * from "./blocks.ts";
57
export * from "./node/node.ts";

0 commit comments

Comments
 (0)