From 602bfcfa5899bcffbf3501c0fc92ca6a0ee55998 Mon Sep 17 00:00:00 2001 From: Tomoyuki Hata Date: Sat, 20 Feb 2021 11:23:38 +0900 Subject: [PATCH] Add @template description --- docs/CHANGELOG.md | 1 - types/data-formats/output-data.d.ts | 9 ++++++--- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index b52206f7f..1970fa671 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -4,7 +4,6 @@ - `New` - `toolbar.toggleBlockSettings()` API method added [#1442](https://github.com/codex-team/editor.js/issues/1421). - `Improvements` - A generic type for Tool config added [#1516](https://github.com/codex-team/editor.js/issues/1516) -- `Improvements` - A generic type for OutputBlockData added [#1326](https://github.com/codex-team/editor.js/pull/1326) - `Improvements` - Remove unused `force` option in `Caret.navigateNext()` and `Caret.navigatePrevious()` [#857](https://github.com/codex-team/editor.js/issues/857#issuecomment-770363438). - `Improvements` - Remove bundles from the repo [#1541](https://github.com/codex-team/editor.js/pull/1541). - `Improvements` - Document will be scrolled when blocks are selected with `SHIFT+UP` or `SHIFT+DOWN` [#1447](https://github.com/codex-team/editor.js/issues/1447) diff --git a/types/data-formats/output-data.d.ts b/types/data-formats/output-data.d.ts index 010b1b237..1e2c0a644 100644 --- a/types/data-formats/output-data.d.ts +++ b/types/data-formats/output-data.d.ts @@ -2,16 +2,19 @@ import {BlockToolData} from '../tools'; /** * Output of one Tool + * + * @template Type - the string literal describing a tool type + * @template Data - the structure describing a data object supported by the tool */ -export interface OutputBlockData { +export interface OutputBlockData { /** * Tool type */ - type: S; + type: Type; /** * Saved Block data */ - data: BlockToolData; + data: BlockToolData; } export interface OutputData {