PrivateCoffee/tldraw
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Export TLCommandHistoryOptions type (#2598)

Browse source 
Export TLCommandHistoryOptions type.

### Change Type

- [x] `patch` — Bug fix

### Release Notes

- Added TLCommandHistoryOptions to the exported types.
This commit is contained in:
Steve Ruiz 2024-01-23 15:27:25 +00:00 committed by GitHub
parent fe254c605b
commit ce85eaac34
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 52 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
packages/editor/api-report.md
View file

@ -2032,6 +2032,13 @@ export type TLCommandHandler<Data> = {
squash?: (prevData: Data, nextData: Data) => Data; squash?: (prevData: Data, nextData: Data) => Data;
}; };
// @public (undocumented)
export type TLCommandHistoryOptions = Partial<{
squashing: boolean;
ephemeral: boolean;
preservesRedoStack: boolean;
}>;
// @public (undocumented) // @public (undocumented)
export type TLCompleteEvent = (info: TLCompleteEventInfo) => void; export type TLCompleteEvent = (info: TLCompleteEventInfo) => void;

57
packages/editor/api/api.json
View file

@ -14508,7 +14508,7 @@
{ {
"kind": "Reference", "kind": "Reference",
"text": "TLCommandHistoryOptions", "text": "TLCommandHistoryOptions",
"canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -15286,7 +15286,7 @@
{ {
"kind": "Reference", "kind": "Reference",
"text": "TLCommandHistoryOptions", "text": "TLCommandHistoryOptions",
"canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -16217,7 +16217,7 @@
{ {
"kind": "Reference", "kind": "Reference",
"text": "TLCommandHistoryOptions", "text": "TLCommandHistoryOptions",
"canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -16704,7 +16704,7 @@
{ {
"kind": "Reference", "kind": "Reference",
"text": "TLCommandHistoryOptions", "text": "TLCommandHistoryOptions",
"canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -16769,7 +16769,7 @@
{ {
"kind": "Reference", "kind": "Reference",
"text": "TLCommandHistoryOptions", "text": "TLCommandHistoryOptions",
"canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -16848,7 +16848,7 @@
{ {
"kind": "Reference", "kind": "Reference",
"text": "TLCommandHistoryOptions", "text": "TLCommandHistoryOptions",
"canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -16926,7 +16926,7 @@
{ {
"kind": "Reference", "kind": "Reference",
"text": "TLCommandHistoryOptions", "text": "TLCommandHistoryOptions",
"canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -17025,7 +17025,7 @@
{ {
"kind": "Reference", "kind": "Reference",
"text": "TLCommandHistoryOptions", "text": "TLCommandHistoryOptions",
"canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -17949,7 +17949,7 @@
{ {
"kind": "Reference", "kind": "Reference",
"text": "TLCommandHistoryOptions", "text": "TLCommandHistoryOptions",
"canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -18099,7 +18099,7 @@
{ {
"kind": "Reference", "kind": "Reference",
"text": "TLCommandHistoryOptions", "text": "TLCommandHistoryOptions",
"canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -18178,7 +18178,7 @@
{ {
"kind": "Reference", "kind": "Reference",
"text": "TLCommandHistoryOptions", "text": "TLCommandHistoryOptions",
"canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -18261,7 +18261,7 @@
{ {
"kind": "Reference", "kind": "Reference",
"text": "TLCommandHistoryOptions", "text": "TLCommandHistoryOptions",
"canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -18357,7 +18357,7 @@
{ {
"kind": "Reference", "kind": "Reference",
"text": "TLCommandHistoryOptions", "text": "TLCommandHistoryOptions",
"canonicalReference": "@tldraw/editor!~TLCommandHistoryOptions:type" "canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -35953,6 +35953,37 @@
"endIndex": 2 "endIndex": 2
} }
}, },
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/editor!TLCommandHistoryOptions:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type TLCommandHistoryOptions = "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<{\n squashing: boolean;\n ephemeral: boolean;\n preservesRedoStack: boolean;\n}>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/editor/src/lib/editor/types/history-types.ts",
"releaseTag": "Public",
"name": "TLCommandHistoryOptions",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{ {
"kind": "TypeAlias", "kind": "TypeAlias",
"canonicalReference": "@tldraw/editor!TLCompleteEvent:type", "canonicalReference": "@tldraw/editor!TLCompleteEvent:type",

1
packages/editor/src/index.ts
View file

@ -17,6 +17,7 @@ export {
type Atom, type Atom,
type Signal, type Signal,
} from '@tldraw/state' } from '@tldraw/state'
export type { TLCommandHistoryOptions } from './lib/editor/types/history-types'
// eslint-disable-next-line local/no-export-star // eslint-disable-next-line local/no-export-star
export * from '@tldraw/store' export * from '@tldraw/store'
// eslint-disable-next-line local/no-export-star // eslint-disable-next-line local/no-export-star