Add generics to OutputBlockData #1326
Conversation
hata6502
requested review from
gohabereg,
khaydarov and
neSpecc
as code owners
hata6502
force-pushed
the
feature/add-generic-output-block-data
branch
from
cb7a1e2 to
ec19f8b
Compare
hata6502
force-pushed
the
feature/add-generic-output-block-data
branch
from
ec19f8b to
8b0e2c1
Compare
hata6502
force-pushed
the
feature/add-generic-output-block-data
branch
from
8b0e2c1 to
8e31a5b
Compare
|
I create a repository to introduce the better way to use Editor.js with TypeScript. |
types/data-formats/output-data.d.ts
Outdated
| */ | ||
| type: string; | ||
| type: S; |
There was a problem hiding this comment.
The type is always a string. Are you sure we need a generic here?
There was a problem hiding this comment.
By using Generics, Editor.js users can describe string literal types.
https://www.typescriptlang.org/docs/handbook/literal-types.html#string-literal-types
By using string literal types in OutputBlockData['type'], Editor.js users can describe more type-safe OutputData in each application.
See also:
https://github.com/hata6502/editorjs-examples/blob/main/examples/ExampleEditorJSData.ts#L17
types/data-formats/output-data.d.ts
Outdated
| @@ -3,15 +3,15 @@ import {BlockToolData} from '../tools'; | |||
| /** | |||
| * Output of one Tool | |||
| */ | |||
| export interface OutputBlockData { | |||
| export interface OutputBlockData<S extends string = string, T extends object = any> { | |||
There was a problem hiding this comment.
| export interface OutputBlockData<S extends string = string, T extends object = any> { | |
| export interface OutputBlockData<S extends string = string, Data extends object = any> { |
There was a problem hiding this comment.
and describe it via @template please
hata6502
force-pushed
the
feature/add-generic-output-block-data
branch
from
5a895e0 to
85d1dac
Compare
hata6502
force-pushed
the
feature/add-generic-output-block-data
branch
from
85d1dac to
602bfcf
Compare
#1551