PrivateCoffee/tldraw
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
tldraw/packages/state/api/api.json

3141 lines
102 KiB
JSON
Raw Normal View History

Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
New migrations again (#3220) Describe what your pull request does. If appropriate, add GIFs or images showing the before and after. ### Change Type - [x] `sdk` — Changes the tldraw SDK - [x] `galaxy brain` — Architectural changes ### Test Plan 1. Add a step-by-step description of how to test your PR here. 2. - [ ] Unit Tests - [ ] End to end tests ### Release Notes #### BREAKING CHANGES - The `Migrations` type is now called `LegacyMigrations`. - The serialized schema format (e.g. returned by `StoreSchema.serialize()` and `Store.getSnapshot()`) has changed. You don't need to do anything about it unless you were reading data directly from the schema for some reason. In which case it'd be best to avoid that in the future! We have no plans to change the schema format again (this time was traumatic enough) but you never know. - `compareRecordVersions` and the `RecordVersion` type have both disappeared. There is no replacement. These were public by mistake anyway, so hopefully nobody had been using it. - `compareSchemas` is a bit less useful now. Our migrations system has become a little fuzzy to allow for simpler UX when adding/removing custom extensions and 3rd party dependencies, and as a result we can no longer compare serialized schemas in any rigorous manner. You can rely on this function to return `0` if the schemas are the same. Otherwise it will return `-1` if the schema on the right _seems_ to be newer than the schema on the left, but it cannot guarantee that in situations where migration sequences have been removed over time (e.g. if you remove one of the builtin tldraw shapes). Generally speaking, the best way to check schema compatibility now is to call `store.schema.getMigrationsSince(persistedSchema)`. This will throw an error if there is no upgrade path from the `persistedSchema` to the current version. - `defineMigrations` has been deprecated and will be removed in a future release. For upgrade instructions see https://tldraw.dev/docs/persistence#Updating-legacy-shape-migrations-defineMigrations - `migrate` has been removed. Nobody should have been using this but if you were you'll need to find an alternative. For migrating tldraw data, you should stick to using `schema.migrateStoreSnapshot` and, if you are building a nuanced sync engine that supports some amount of backwards compatibility, also feel free to use `schema.migratePersistedRecord`. - the `Migration` type has changed. If you need the old one for some reason it has been renamed to `LegacyMigration`. It will be removed in a future release. - the `Migrations` type has been renamed to `LegacyMigrations` and will be removed in a future release. - the `SerializedSchema` type has been augmented. If you need the old version specifically you can use `SerializedSchemaV1` --------- Co-authored-by: Steve Ruiz <steveruizok@gmail.com>
2024-04-15 12:53:42 +00:00
"toolVersion": "7.43.1",
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"schemaVersion": 1011,
"oldestForwardsCompatibleVersion": 1001,
"tsdocConfig": {
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
"noStandardTags": true,
"tagDefinitions": [
{
"tagName": "@alpha",
"syntaxKind": "modifier"
},
{
"tagName": "@beta",
"syntaxKind": "modifier"
},
{
"tagName": "@defaultValue",
"syntaxKind": "block"
},
{
"tagName": "@decorator",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@deprecated",
"syntaxKind": "block"
},
{
"tagName": "@eventProperty",
"syntaxKind": "modifier"
},
{
"tagName": "@example",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@experimental",
"syntaxKind": "modifier"
},
{
"tagName": "@inheritDoc",
"syntaxKind": "inline"
},
{
"tagName": "@internal",
"syntaxKind": "modifier"
},
{
"tagName": "@label",
"syntaxKind": "inline"
},
{
"tagName": "@link",
"syntaxKind": "inline",
"allowMultiple": true
},
{
"tagName": "@override",
"syntaxKind": "modifier"
},
{
"tagName": "@packageDocumentation",
"syntaxKind": "modifier"
},
{
"tagName": "@param",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@privateRemarks",
"syntaxKind": "block"
},
{
"tagName": "@public",
"syntaxKind": "modifier"
},
{
"tagName": "@readonly",
"syntaxKind": "modifier"
},
{
"tagName": "@remarks",
"syntaxKind": "block"
},
{
"tagName": "@returns",
"syntaxKind": "block"
},
{
"tagName": "@sealed",
"syntaxKind": "modifier"
},
{
"tagName": "@see",
"syntaxKind": "block"
},
{
"tagName": "@throws",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@typeParam",
"syntaxKind": "block",
"allowMultiple": true
},
{
"tagName": "@virtual",
"syntaxKind": "modifier"
},
{
"tagName": "@betaDocumentation",
"syntaxKind": "modifier"
},
{
"tagName": "@internalRemarks",
"syntaxKind": "block"
},
{
"tagName": "@preapproved",
"syntaxKind": "modifier"
}
],
"supportForTags": {
"@alpha": true,
"@beta": true,
"@defaultValue": true,
"@decorator": true,
"@deprecated": true,
"@eventProperty": true,
"@example": true,
"@experimental": true,
"@inheritDoc": true,
"@internal": true,
"@label": true,
"@link": true,
"@override": true,
"@packageDocumentation": true,
"@param": true,
"@privateRemarks": true,
"@public": true,
"@readonly": true,
"@remarks": true,
"@returns": true,
"@sealed": true,
"@see": true,
"@throws": true,
"@typeParam": true,
"@virtual": true,
"@betaDocumentation": true,
"@internalRemarks": true,
"@preapproved": true
},
"reportUnsupportedHtmlElements": false
}
},
"kind": "Package",
"canonicalReference": "@tldraw/state!",
"docComment": "",
"name": "@tldraw/state",
"preserveMemberOrder": false,
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "@tldraw/state!",
"name": "",
"preserveMemberOrder": false,
"members": [
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
{
"kind": "Function",
"canonicalReference": "@tldraw/state!atom:function(1)",
"docComment": "/**\n * Creates a new [[Atom]].\n *\n * An Atom is a signal that can be updated directly by calling [[Atom.set]] or [[Atom.update]].\n *\n * @example\n * ```ts\n * const name = atom('name', 'John')\n *\n * name.get() // 'John'\n *\n * name.set('Jane')\n *\n * name.get() // 'Jane'\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function atom<Value, Diff = "
},
{
"kind": "Content",
"text": "unknown"
},
{
"kind": "Content",
"text": ">(\nname: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", \ninitialValue: "
},
{
"kind": "Content",
"text": "Value"
},
{
"kind": "Content",
"text": ", \noptions?: "
},
{
"kind": "Reference",
"text": "AtomOptions",
"canonicalReference": "@tldraw/state!AtomOptions:interface"
},
{
"kind": "Content",
"text": "<Value, Diff>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Atom",
"canonicalReference": "@tldraw/state!Atom:interface"
},
{
"kind": "Content",
"text": "<Value, Diff>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/state/src/lib/core/Atom.ts",
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "name",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
},
{
"parameterName": "initialValue",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"isOptional": false
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 9
},
"isOptional": true
}
],
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "Diff",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "atom"
},
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
{
"kind": "Interface",
"canonicalReference": "@tldraw/state!Atom:interface",
Replace getters in examples (#2261) Follow up to #2189 ### Change Type - [ ] `patch` — Bug fix - [ ] `minor` — New feature - [ ] `major` — Breaking change - [ ] `dependencies` — Changes to package dependencies[^1] - [x] `documentation` — Changes to the documentation only[^2] - [ ] `tests` — Changes to any test code only[^2] - [ ] `internal` — Any other changes that don't affect the published package[^2] - [ ] I don't know [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-11-28 17:33:10 +00:00
"docComment": "/**\n * An Atom is a signal that can be updated directly by calling [[Atom.set]] or [[Atom.update]].\n *\n * Atoms are created using the [[atom]] function.\n *\n * @example\n * ```ts\n * const name = atom('name', 'John')\n *\n * print(name.get()) // 'John'\n * ```\n *\n * @public\n */\n",
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"excerptTokens": [
{
"kind": "Content",
"text": "export interface Atom<Value, Diff = "
},
{
"kind": "Content",
"text": "unknown"
},
{
"kind": "Content",
"text": "> extends "
},
{
"kind": "Reference",
"text": "Signal",
"canonicalReference": "@tldraw/state!Signal:interface"
},
{
"kind": "Content",
"text": "<Value, Diff>"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/state/src/lib/core/Atom.ts",
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "Diff",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "Atom",
"preserveMemberOrder": false,
"members": [
{
"kind": "MethodSignature",
"canonicalReference": "@tldraw/state!Atom#set:member(1)",
"docComment": "/**\n * Sets the value of this atom to the given value. If the value is the same as the current value, this is a no-op.\n *\n * @param value - The new value to set.\n *\n * @param diff - The diff to use for the update. If not provided, the diff will be computed using [[AtomOptions.computeDiff]].\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "set(value: "
},
{
"kind": "Content",
"text": "Value"
},
{
"kind": "Content",
"text": ", diff?: "
},
{
"kind": "Content",
"text": "Diff"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "Value"
},
{
"kind": "Content",
"text": ";"
}
],
"isOptional": false,
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "diff",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": true
}
],
"name": "set"
},
{
"kind": "MethodSignature",
"canonicalReference": "@tldraw/state!Atom#update:member(1)",
"docComment": "/**\n * Updates the value of this atom using the given updater function. If the returned value is the same as the current value, this is a no-op.\n *\n * @param updater - A function that takes the current value and returns the new value.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "update(updater: "
},
{
"kind": "Content",
"text": "(value: Value) => Value"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "Value"
},
{
"kind": "Content",
"text": ";"
}
],
"isOptional": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "updater",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "update"
}
],
"extendsTokenRanges": [
{
"startIndex": 3,
"endIndex": 5
}
]
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/state!AtomOptions:interface",
"docComment": "/**\n * The options to configure an atom, passed into the [[atom]] function.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface AtomOptions<Value, Diff> "
}
],
"fileUrlPath": "packages/state/src/lib/core/Atom.ts",
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "Diff",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "AtomOptions",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/state!AtomOptions#computeDiff:member",
"docComment": "/**\n * A method used to compute a diff between the atom's old and new values. If provided, it will not be used unless you also specify [[AtomOptions.historyLength]].\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "computeDiff?: "
},
{
"kind": "Reference",
"text": "ComputeDiff",
"canonicalReference": "@tldraw/state!~ComputeDiff:type"
},
{
"kind": "Content",
"text": "<Value, Diff>"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "computeDiff",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/state!AtomOptions#historyLength:member",
"docComment": "/**\n * The maximum number of diffs to keep in the history buffer.\n *\n * If you don't need to compute diffs, or if you will supply diffs manually via [[Atom.set]], you can leave this as `undefined` and no history buffer will be created.\n *\n * If you expect the value to be part of an active effect subscription all the time, and to not change multiple times inside of a single transaction, you can set this to a relatively low number (e.g. 10).\n *\n * Otherwise, set this to a higher number based on your usage pattern and memory constraints.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "historyLength?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "historyLength",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/state!AtomOptions#isEqual:member",
"docComment": "/**\n * If provided, this will be used to compare the old and new values of the atom to determine if the value has changed. By default, values are compared using first using strict equality (`===`), then `Object.is`, and finally any `.equals` method present in the object's prototype chain.\n *\n * @param a - The old value\n *\n * @param b - The new value\n *\n * @returns \n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "isEqual?: "
},
{
"kind": "Content",
"text": "(a: any, b: any) => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "isEqual",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"kind": "Function",
"canonicalReference": "@tldraw/state!computed:function(1)",
"docComment": "/**\n * Creates a computed signal.\n *\n * @param name - The name of the signal.\n *\n * @param compute - The function that computes the value of the signal.\n *\n * @param options - Options for the signal.\n *\n * @example\n * ```ts\n * const name = atom('name', 'John')\n * const greeting = computed('greeting', () => `Hello ${name.get()}!`)\n * console.log(greeting.get()) // 'Hello John!'\n * ```\n *\n * `computed` may also be used as a decorator for creating computed getter methods.\n *\n * @example\n * ```ts\n * class Counter {\n * max = 100\n * count = atom<number>(0)\n *\n * @computed getRemaining() {\n * return this.max - this.count.get()\n * }\n * }\n * ```\n *\n * You may optionally pass in a [[ComputedOptions]] when used as a decorator:\n *\n * @example\n * ```ts\n * class Counter {\n * max = 100\n * count = atom<number>(0)\n *\n * @computed({isEqual: (a, b) => a === b})\n * getRemaining() {\n * return this.max - this.count.get()\n * }\n * }\n * ```\n *\n * @public\n */\n",
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"excerptTokens": [
{
"kind": "Content",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "export declare function computed<Value, Diff = "
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Content",
"text": "unknown"
},
{
"kind": "Content",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": ">(name: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", compute: "
},
{
"kind": "Content",
"text": "(previousValue: typeof "
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Reference",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "UNINITIALIZED",
"canonicalReference": "@tldraw/state!~UNINITIALIZED:var"
},
{
"kind": "Content",
"text": " | Value, lastComputedEpoch: number) => Value | "
},
{
"kind": "Reference",
"text": "WithDiff",
"canonicalReference": "@tldraw/state!~WithDiff:type"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Content",
"text": "<Value, Diff>"
},
{
"kind": "Content",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": ", options?: "
},
{
"kind": "Reference",
"text": "ComputedOptions",
"canonicalReference": "@tldraw/state!ComputedOptions:interface"
},
{
"kind": "Content",
"text": "<Value, Diff>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Computed",
"canonicalReference": "@tldraw/state!Computed:interface"
},
{
"kind": "Content",
"text": "<Value, Diff>"
},
{
"kind": "Content",
"text": ";"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
}
],
"fileUrlPath": "packages/state/src/lib/core/Computed.ts",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 16
},
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"releaseTag": "Public",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"overloadIndex": 1,
"parameters": [
{
"parameterName": "name",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
},
{
"parameterName": "compute",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 10
},
"isOptional": false
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 11,
"endIndex": 13
},
"isOptional": true
}
],
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "Diff",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"name": "computed"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"kind": "Function",
"canonicalReference": "@tldraw/state!computed:function(2)",
"docComment": "/**\n * @public\n */\n",
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"excerptTokens": [
{
"kind": "Content",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "export declare function computed(target: "
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Content",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "any"
},
{
"kind": "Content",
"text": ", key: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", descriptor: "
},
{
"kind": "Reference",
"text": "PropertyDescriptor",
"canonicalReference": "!PropertyDescriptor:interface"
},
{
"kind": "Content",
"text": "): "
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Reference",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "PropertyDescriptor",
"canonicalReference": "!PropertyDescriptor:interface"
},
{
"kind": "Content",
"text": ";"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
}
],
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"fileUrlPath": "packages/state/src/lib/core/Computed.ts",
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"releaseTag": "Public",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"overloadIndex": 2,
"parameters": [
{
"parameterName": "target",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
},
{
"parameterName": "descriptor",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"isOptional": false
}
],
"name": "computed"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/state!computed:function(3)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function computed<Value, Diff = "
},
{
"kind": "Content",
"text": "unknown"
},
{
"kind": "Content",
"text": ">(options?: "
},
{
"kind": "Reference",
"text": "ComputedOptions",
"canonicalReference": "@tldraw/state!ComputedOptions:interface"
},
{
"kind": "Content",
"text": "<Value, Diff>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "(target: any, key: string, descriptor: "
},
{
"kind": "Reference",
"text": "PropertyDescriptor",
"canonicalReference": "!PropertyDescriptor:interface"
},
{
"kind": "Content",
"text": ") => "
},
{
"kind": "Reference",
"text": "PropertyDescriptor",
"canonicalReference": "!PropertyDescriptor:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/state/src/lib/core/Computed.ts",
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 10
},
"releaseTag": "Public",
"overloadIndex": 3,
"parameters": [
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"isOptional": true
}
],
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "Diff",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "computed"
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/state!Computed:interface",
"docComment": "/**\n * A computed signal created via [[computed]].\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface Computed<Value, Diff = "
},
{
"kind": "Content",
"text": "unknown"
},
{
"kind": "Content",
"text": "> extends "
},
{
"kind": "Reference",
"text": "Signal",
"canonicalReference": "@tldraw/state!Signal:interface"
},
{
"kind": "Content",
"text": "<Value, Diff>"
},
{
"kind": "Content",
"text": " "
}
],
"fileUrlPath": "packages/state/src/lib/core/Computed.ts",
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "Diff",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "Computed",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/state!Computed#isActivelyListening:member",
"docComment": "/**\n * Whether this computed child is involved in an actively-running effect graph.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly isActivelyListening: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": true,
"isOptional": false,
"releaseTag": "Public",
"name": "isActivelyListening",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": [
{
"startIndex": 3,
"endIndex": 5
}
]
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/state!ComputedOptions:interface",
"docComment": "/**\n * Options for creating computed signals. Used when calling [[computed]].\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface ComputedOptions<Value, Diff> "
}
],
"fileUrlPath": "packages/state/src/lib/core/Computed.ts",
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "Diff",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "ComputedOptions",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/state!ComputedOptions#computeDiff:member",
"docComment": "/**\n * A method used to compute a diff between the atom's old and new values. If provided, it will not be used unless you also specify [[AtomOptions.historyLength]].\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "computeDiff?: "
},
{
"kind": "Reference",
"text": "ComputeDiff",
"canonicalReference": "@tldraw/state!~ComputeDiff:type"
},
{
"kind": "Content",
"text": "<Value, Diff>"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "computeDiff",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/state!ComputedOptions#historyLength:member",
"docComment": "/**\n * The maximum number of diffs to keep in the history buffer.\n *\n * If you don't need to compute diffs, or if you will supply diffs manually via [[Atom.set]], you can leave this as `undefined` and no history buffer will be created.\n *\n * If you expect the value to be part of an active effect subscription all the time, and to not change multiple times inside of a single transaction, you can set this to a relatively low number (e.g. 10).\n *\n * Otherwise, set this to a higher number based on your usage pattern and memory constraints.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "historyLength?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "historyLength",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/state!ComputedOptions#isEqual:member",
"docComment": "/**\n * If provided, this will be used to compare the old and new values of the atom to determine if the value has changed. By default, values are compared using first using strict equality (`===`), then `Object.is`, and finally any `.equals` method present in the object's prototype chain.\n *\n * @param a - The old value\n *\n * @param b - The new value\n *\n * @returns \n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "isEqual?: "
},
{
"kind": "Content",
"text": "(a: any, b: any) => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": true,
"releaseTag": "Public",
"name": "isEqual",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
Use a global singleton for tlstate (#2322) One minor issue with signia is that it uses global state for bookkeeping, so it is potentially disastrous if there is more than one version of it included in a bundle. To prevent that being an issue before we had a warning that would trigger if signia detects multiple initializations. > Multiple versions of @tldraw/state detected. This will cause unexpected behavior. Please add "resolutions" (yarn/pnpm) or "overrides" (npm) in your package.json to ensure only one version of @tldraw/state is loaded. Alas I think this warning triggers too often in development environments, e.g. during HMR or janky bundlers. Something that can prevent the need for this particular warning is having a global singleton version of signia that we only instantiate once, and then re-use that one on subsequent module initializations. We didn't do this before because it has a few downsides: - breaks HMR if you are working on signia itself, since updated modules won't be used and you'll need to do a full refresh. - introduces the possibility of breakage if we remove or even add APIs to signia. We can't rely on having the latest version of signia be the first to instantiate, and we can't allow later instantiations to take precedence since atoms n stuff may have already been created with the prior version. To mitigate this I've introduced a `apiVersion` const that we can increment when we make any kind of additions or removals. If there is a mismatch between the `apiVersion` in the global singleton vs the currently-initializing module, then it throws. Ultimately i think the pros outweigh the cons here, i.e. far fewer people will see and have to deal with the error message shown above, and fewer people should encounter a situation where the editor appears to load but nothing changes when you interact with it. ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version ### Release Notes - Make a global singleton for tlstate.
2023-12-14 13:35:34 +00:00
],
"extendsTokenRanges": []
},
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/state!EffectScheduler:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type EffectScheduler<Result> = "
},
{
"kind": "Reference",
"text": "__EffectScheduler__",
"canonicalReference": "@tldraw/state!~__EffectScheduler__:class"
},
{
"kind": "Content",
"text": "<Result>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/state/src/lib/core/EffectScheduler.ts",
"releaseTag": "Public",
"name": "EffectScheduler",
"typeParameters": [
{
"typeParameterName": "Result",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
Use a global singleton for tlstate (#2322) One minor issue with signia is that it uses global state for bookkeeping, so it is potentially disastrous if there is more than one version of it included in a bundle. To prevent that being an issue before we had a warning that would trigger if signia detects multiple initializations. > Multiple versions of @tldraw/state detected. This will cause unexpected behavior. Please add "resolutions" (yarn/pnpm) or "overrides" (npm) in your package.json to ensure only one version of @tldraw/state is loaded. Alas I think this warning triggers too often in development environments, e.g. during HMR or janky bundlers. Something that can prevent the need for this particular warning is having a global singleton version of signia that we only instantiate once, and then re-use that one on subsequent module initializations. We didn't do this before because it has a few downsides: - breaks HMR if you are working on signia itself, since updated modules won't be used and you'll need to do a full refresh. - introduces the possibility of breakage if we remove or even add APIs to signia. We can't rely on having the latest version of signia be the first to instantiate, and we can't allow later instantiations to take precedence since atoms n stuff may have already been created with the prior version. To mitigate this I've introduced a `apiVersion` const that we can increment when we make any kind of additions or removals. If there is a mismatch between the `apiVersion` in the global singleton vs the currently-initializing module, then it throws. Ultimately i think the pros outweigh the cons here, i.e. far fewer people will see and have to deal with the error message shown above, and fewer people should encounter a situation where the editor appears to load but nothing changes when you interact with it. ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version ### Release Notes - Make a global singleton for tlstate.
2023-12-14 13:35:34 +00:00
{
"kind": "Variable",
"canonicalReference": "@tldraw/state!EffectScheduler:var",
"docComment": "/**\n * An EffectScheduler is responsible for executing side effects in response to changes in state.\n *\n * You probably don't need to use this directly unless you're integrating this library with a framework of some kind.\n *\n * Instead, use the [[react]] and [[reactor]] functions.\n *\n * @example\n * ```ts\n * const render = new EffectScheduler('render', drawToCanvas)\n *\n * render.attach()\n * render.execute()\n * ```\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "EffectScheduler: "
},
{
"kind": "Content",
"text": "typeof "
},
{
"kind": "Reference",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "__EffectScheduler__",
"canonicalReference": "@tldraw/state!~__EffectScheduler__:class"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
}
],
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"fileUrlPath": "packages/state/src/lib/core/EffectScheduler.ts",
Use a global singleton for tlstate (#2322) One minor issue with signia is that it uses global state for bookkeeping, so it is potentially disastrous if there is more than one version of it included in a bundle. To prevent that being an issue before we had a warning that would trigger if signia detects multiple initializations. > Multiple versions of @tldraw/state detected. This will cause unexpected behavior. Please add "resolutions" (yarn/pnpm) or "overrides" (npm) in your package.json to ensure only one version of @tldraw/state is loaded. Alas I think this warning triggers too often in development environments, e.g. during HMR or janky bundlers. Something that can prevent the need for this particular warning is having a global singleton version of signia that we only instantiate once, and then re-use that one on subsequent module initializations. We didn't do this before because it has a few downsides: - breaks HMR if you are working on signia itself, since updated modules won't be used and you'll need to do a full refresh. - introduces the possibility of breakage if we remove or even add APIs to signia. We can't rely on having the latest version of signia be the first to instantiate, and we can't allow later instantiations to take precedence since atoms n stuff may have already been created with the prior version. To mitigate this I've introduced a `apiVersion` const that we can increment when we make any kind of additions or removals. If there is a mismatch between the `apiVersion` in the global singleton vs the currently-initializing module, then it throws. Ultimately i think the pros outweigh the cons here, i.e. far fewer people will see and have to deal with the error message shown above, and fewer people should encounter a situation where the editor appears to load but nothing changes when you interact with it. ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version ### Release Notes - Make a global singleton for tlstate.
2023-12-14 13:35:34 +00:00
"isReadonly": true,
"releaseTag": "Public",
"name": "EffectScheduler",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Variable",
"canonicalReference": "@tldraw/state!EMPTY_ARRAY:var",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "EMPTY_ARRAY: "
},
{
"kind": "Content",
"text": "[]"
}
],
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"fileUrlPath": "packages/state/src/lib/core/helpers.ts",
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"isReadonly": true,
"releaseTag": "Public",
"name": "EMPTY_ARRAY",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Function",
"canonicalReference": "@tldraw/state!getComputedInstance:function(1)",
Replace getters in examples (#2261) Follow up to #2189 ### Change Type - [ ] `patch` — Bug fix - [ ] `minor` — New feature - [ ] `major` — Breaking change - [ ] `dependencies` — Changes to package dependencies[^1] - [x] `documentation` — Changes to the documentation only[^2] - [ ] `tests` — Changes to any test code only[^2] - [ ] `internal` — Any other changes that don't affect the published package[^2] - [ ] I don't know [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-11-28 17:33:10 +00:00
"docComment": "/**\n * Retrieves the underlying computed instance for a given property created with the [[computed]] decorator.\n *\n * @param obj - The object\n *\n * @param propertyName - The property name\n *\n * @example\n * ```ts\n * class Counter {\n * max = 100\n * count = atom(0)\n *\n * @computed getRemaining() {\n * return this.max - this.count.get()\n * }\n * }\n *\n * const c = new Counter()\n * const remaining = getComputedInstance(c, 'getRemaining')\n * remaining.get() === 100 // true\n * c.count.set(13)\n * remaining.get() === 87 // true\n * ```\n *\n * @public\n */\n",
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function getComputedInstance<Obj extends "
},
{
"kind": "Content",
"text": "object"
},
{
"kind": "Content",
"text": ", Prop extends "
},
{
"kind": "Content",
"text": "keyof Obj"
},
{
"kind": "Content",
"text": ">(obj: "
},
{
"kind": "Content",
"text": "Obj"
},
{
"kind": "Content",
"text": ", propertyName: "
},
{
"kind": "Content",
"text": "Prop"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Computed",
"canonicalReference": "@tldraw/state!Computed:interface"
},
{
"kind": "Content",
"text": "<Obj[Prop]>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/state/src/lib/core/Computed.ts",
"returnTypeTokenRange": {
"startIndex": 9,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "obj",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"isOptional": false
},
{
"parameterName": "propertyName",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"isOptional": false
}
],
"typeParameters": [
{
"typeParameterName": "Obj",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "Prop",
"constraintTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "getComputedInstance"
},
{
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"kind": "Function",
"canonicalReference": "@tldraw/state!isAtom:function(1)",
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"docComment": "/**\n * Returns true if the given value is an [[Atom]].\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "export declare function isAtom(value: "
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Content",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "unknown"
},
{
"kind": "Content",
"text": "): "
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Reference",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "value",
"canonicalReference": "@tldraw/state!~value"
},
{
"kind": "Content",
"text": " is "
},
{
"kind": "Reference",
"text": "Atom",
"canonicalReference": "@tldraw/state!Atom:interface"
},
{
"kind": "Content",
"text": "<unknown>"
},
{
"kind": "Content",
"text": ";"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
}
],
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"fileUrlPath": "packages/state/src/lib/core/Atom.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 7
},
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"releaseTag": "Public",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"overloadIndex": 1,
"parameters": [
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "isAtom"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"kind": "Function",
"canonicalReference": "@tldraw/state!isSignal:function(1)",
"docComment": "/**\n * @public\n */\n",
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"excerptTokens": [
{
"kind": "Content",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "export declare function isSignal(value: "
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Content",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "any"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "value",
"canonicalReference": "@tldraw/state!~value"
},
{
"kind": "Content",
"text": " is "
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Reference",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "Signal",
"canonicalReference": "@tldraw/state!Signal:interface"
},
{
"kind": "Content",
"text": "<any>"
},
{
"kind": "Content",
"text": ";"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
}
],
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"fileUrlPath": "packages/state/src/lib/core/isSignal.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 7
},
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"releaseTag": "Public",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"overloadIndex": 1,
"parameters": [
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "isSignal"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
bump typescript / api-extractor (#2949) This PR bumps TypeScript to 5.3.3 and API extractor. We started getting some weird behavior in CI due to different versions of the two libraries, ie where the CI api.jsons would differ from those built locally. ### Change Type - [x] `dependencies` — Changes to package dependencies[^1]
2024-02-25 11:43:17 +00:00
"kind": "Function",
"canonicalReference": "@tldraw/state!isUninitialized:function(1)",
Replace getters in examples (#2261) Follow up to #2189 ### Change Type - [ ] `patch` — Bug fix - [ ] `minor` — New feature - [ ] `major` — Breaking change - [ ] `dependencies` — Changes to package dependencies[^1] - [x] `documentation` — Changes to the documentation only[^2] - [ ] `tests` — Changes to any test code only[^2] - [ ] `internal` — Any other changes that don't affect the published package[^2] - [ ] I don't know [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-11-28 17:33:10 +00:00
"docComment": "/**\n * Call this inside a computed signal function to determine whether it is the first time the function is being called.\n *\n * Mainly useful for incremental signal computation.\n *\n * @param value - The value to check.\n *\n * @example\n * ```ts\n * const count = atom('count', 0)\n * const double = computed('double', (prevValue) => {\n * if (isUninitialized(prevValue)) {\n * print('First time!')\n * }\n * return count.get() * 2\n * })\n * ```\n *\n * @public\n */\n",
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"excerptTokens": [
{
"kind": "Content",
bump typescript / api-extractor (#2949) This PR bumps TypeScript to 5.3.3 and API extractor. We started getting some weird behavior in CI due to different versions of the two libraries, ie where the CI api.jsons would differ from those built locally. ### Change Type - [x] `dependencies` — Changes to package dependencies[^1]
2024-02-25 11:43:17 +00:00
"text": "isUninitialized: (value: "
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Content",
bump typescript / api-extractor (#2949) This PR bumps TypeScript to 5.3.3 and API extractor. We started getting some weird behavior in CI due to different versions of the two libraries, ie where the CI api.jsons would differ from those built locally. ### Change Type - [x] `dependencies` — Changes to package dependencies[^1]
2024-02-25 11:43:17 +00:00
"text": "any"
},
{
"kind": "Content",
"text": ") => "
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Reference",
"text": "value",
"canonicalReference": "@tldraw/state!~value"
},
{
"kind": "Content",
"text": " is typeof "
},
{
"kind": "Reference",
"text": "UNINITIALIZED",
"canonicalReference": "@tldraw/state!~UNINITIALIZED:var"
}
],
"fileUrlPath": "packages/state/src/lib/core/Computed.ts",
bump typescript / api-extractor (#2949) This PR bumps TypeScript to 5.3.3 and API extractor. We started getting some weird behavior in CI due to different versions of the two libraries, ie where the CI api.jsons would differ from those built locally. ### Change Type - [x] `dependencies` — Changes to package dependencies[^1]
2024-02-25 11:43:17 +00:00
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 6
},
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"releaseTag": "Public",
bump typescript / api-extractor (#2949) This PR bumps TypeScript to 5.3.3 and API extractor. We started getting some weird behavior in CI due to different versions of the two libraries, ie where the CI api.jsons would differ from those built locally. ### Change Type - [x] `dependencies` — Changes to package dependencies[^1]
2024-02-25 11:43:17 +00:00
"overloadIndex": 1,
"parameters": [
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "isUninitialized"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"kind": "Function",
"canonicalReference": "@tldraw/state!react:function(1)",
Replace getters in examples (#2261) Follow up to #2189 ### Change Type - [ ] `patch` — Bug fix - [ ] `minor` — New feature - [ ] `major` — Breaking change - [ ] `dependencies` — Changes to package dependencies[^1] - [x] `documentation` — Changes to the documentation only[^2] - [ ] `tests` — Changes to any test code only[^2] - [ ] `internal` — Any other changes that don't affect the published package[^2] - [ ] I don't know [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-11-28 17:33:10 +00:00
"docComment": "/**\n * Starts a new effect scheduler, scheduling the effect immediately.\n *\n * Returns a function that can be called to stop the scheduler.\n *\n * @example\n * ```ts\n * const color = atom('color', 'red')\n * const stop = react('set style', () => {\n * divElem.style.color = color.get()\n * })\n * color.set('blue')\n * // divElem.style.color === 'blue'\n * stop()\n * color.set('green')\n * // divElem.style.color === 'blue'\n * ```\n *\n * Also useful in React applications for running effects outside of the render cycle.\n *\n * @example\n * ```ts\n * useEffect(() => react('set style', () => {\n * divRef.current.style.color = color.get()\n * }), [])\n * ```\n *\n * @public\n */\n",
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"excerptTokens": [
{
"kind": "Content",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "export declare function react(name: "
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Content",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "string"
},
{
"kind": "Content",
"text": ", fn: "
},
{
"kind": "Content",
"text": "(lastReactedEpoch: number) => any"
},
{
"kind": "Content",
"text": ", options?: "
Use a global singleton for tlstate (#2322) One minor issue with signia is that it uses global state for bookkeeping, so it is potentially disastrous if there is more than one version of it included in a bundle. To prevent that being an issue before we had a warning that would trigger if signia detects multiple initializations. > Multiple versions of @tldraw/state detected. This will cause unexpected behavior. Please add "resolutions" (yarn/pnpm) or "overrides" (npm) in your package.json to ensure only one version of @tldraw/state is loaded. Alas I think this warning triggers too often in development environments, e.g. during HMR or janky bundlers. Something that can prevent the need for this particular warning is having a global singleton version of signia that we only instantiate once, and then re-use that one on subsequent module initializations. We didn't do this before because it has a few downsides: - breaks HMR if you are working on signia itself, since updated modules won't be used and you'll need to do a full refresh. - introduces the possibility of breakage if we remove or even add APIs to signia. We can't rely on having the latest version of signia be the first to instantiate, and we can't allow later instantiations to take precedence since atoms n stuff may have already been created with the prior version. To mitigate this I've introduced a `apiVersion` const that we can increment when we make any kind of additions or removals. If there is a mismatch between the `apiVersion` in the global singleton vs the currently-initializing module, then it throws. Ultimately i think the pros outweigh the cons here, i.e. far fewer people will see and have to deal with the error message shown above, and fewer people should encounter a situation where the editor appears to load but nothing changes when you interact with it. ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version ### Release Notes - Make a global singleton for tlstate.
2023-12-14 13:35:34 +00:00
},
{
"kind": "Reference",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "EffectSchedulerOptions",
"canonicalReference": "@tldraw/state!~EffectSchedulerOptions:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/state/src/lib/core/EffectScheduler.ts",
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "name",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "fn",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"isOptional": true
}
],
"name": "react"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/state!reactor:function(1)",
"docComment": "/**\n * Creates a [[Reactor]], which is a thin wrapper around an [[EffectScheduler]].\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function reactor<Result>(name: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", fn: "
},
{
"kind": "Content",
"text": "(lastReactedEpoch: number) => Result"
},
{
"kind": "Content",
"text": ", options?: "
},
{
"kind": "Reference",
"text": "EffectSchedulerOptions",
"canonicalReference": "@tldraw/state!~EffectSchedulerOptions:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Reactor",
"canonicalReference": "@tldraw/state!Reactor:interface"
},
{
"kind": "Content",
"text": "<Result>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/state/src/lib/core/EffectScheduler.ts",
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 9
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "name",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "fn",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"isOptional": true
}
],
"typeParameters": [
{
"typeParameterName": "Result",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
}
],
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"name": "reactor"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/state!Reactor:interface",
"docComment": "/**\n * The reactor is a user-friendly interface for starting and stopping an [[EffectScheduler]].\n *\n * Calling .start() will attach the scheduler and execute the effect immediately the first time it is called.\n *\n * If the reactor is stopped, calling `.start()` will re-attach the scheduler but will only execute the effect if any of its parents have changed since it was stopped.\n *\n * You can create a reactor with [[reactor]].\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface Reactor<T = "
},
{
"kind": "Content",
"text": "unknown"
},
{
"kind": "Content",
"text": "> "
}
],
"fileUrlPath": "packages/state/src/lib/core/EffectScheduler.ts",
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "Reactor",
"preserveMemberOrder": false,
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/state!Reactor#scheduler:member",
"docComment": "/**\n * The underlying effect scheduler.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "scheduler: "
},
{
"kind": "Reference",
"text": "EffectScheduler",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"canonicalReference": "@tldraw/state!EffectScheduler:type"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "scheduler",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "MethodSignature",
"canonicalReference": "@tldraw/state!Reactor#start:member(1)",
"docComment": "/**\n * Start the scheduler. The first time this is called the effect will be scheduled immediately.\n *\n * If the reactor is stopped, calling this will start the scheduler again but will only execute the effect if any of its parents have changed since it was stopped.\n *\n * If you need to force re-execution of the effect, pass `{ force: true }`.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "start(options?: "
},
{
"kind": "Content",
"text": "{\n force?: boolean;\n }"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isOptional": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": true
}
],
"name": "start"
},
{
"kind": "MethodSignature",
"canonicalReference": "@tldraw/state!Reactor#stop:member(1)",
"docComment": "/**\n * Stop the scheduler.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "stop(): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isOptional": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "stop"
}
],
"extendsTokenRanges": []
},
{
"kind": "TypeAlias",
"canonicalReference": "@tldraw/state!RESET_VALUE:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export type RESET_VALUE = "
},
{
"kind": "Content",
"text": "typeof "
},
{
"kind": "Reference",
"text": "RESET_VALUE",
"canonicalReference": "@tldraw/state!RESET_VALUE:var"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/state/src/lib/core/types.ts",
"releaseTag": "Public",
"name": "RESET_VALUE",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "Variable",
"canonicalReference": "@tldraw/state!RESET_VALUE:var",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "RESET_VALUE: "
},
{
"kind": "Content",
"text": "unique symbol"
}
],
"fileUrlPath": "packages/state/src/lib/core/types.ts",
"isReadonly": true,
"releaseTag": "Public",
"name": "RESET_VALUE",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Interface",
"canonicalReference": "@tldraw/state!Signal:interface",
"docComment": "/**\n * A Signal is a reactive value container. The value may change over time, and it may keep track of the diffs between sequential values.\n *\n * There are two types of signal:\n *\n * - Atomic signals, created using [[atom]]. These are mutable references to values that can be changed using [[Atom.set]]. - Computed signals, created using [[computed]]. These are values that are computed from other signals. They are recomputed lazily if their dependencies change.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface Signal<Value, Diff = "
},
{
"kind": "Content",
"text": "unknown"
},
{
"kind": "Content",
"text": "> "
}
],
"fileUrlPath": "packages/state/src/lib/core/types.ts",
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "Diff",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "Signal",
"preserveMemberOrder": false,
"members": [
{
"kind": "MethodSignature",
"canonicalReference": "@tldraw/state!Signal#__unsafe__getWithoutCapture:member(1)",
"docComment": "/**\n * Returns the current value of the signal without capturing it as a dependency. Use this if you need to retrieve the signal's value in a hot loop where the performance overhead of dependency tracking is too high.\n */\n",
"excerptTokens": [
{
"kind": "Content",
Improve signia error handling (#2835) This PR revamps how errors in signia are handled. This was brought about by a situation that @MitjaBezensek encountered where he added a reactor to a shape util class. During fuzz tests, that reactor was being executed at times when the Editor was not in a usable state (we had a minor hole in our sync rebase logic that allowed this, fixed elsewhere) and the reactor was throwing errors because it dereferenced a parent signal that relied on the page state (getShapesInCurrentPage or whatever) when there were no page records in the store. The strange part was that even if we wrapped the body of the reactor function in a try/catch, ignoring the error, we'd still see the error bubble up somehow. That was because the error was being thrown in a Computed derive function, and those are evaluated independently (i.e. outside of the reactor function) by signia as it traverses the dependency graph from leaves to roots in the `haveParentsChanged()` internal function. So the immediate fix was to make it so that `haveParentsChanged` ignores errors somehow. But the better fix involved completely revamping how signia handles errors, and they work very much like how signia handles values now. i.e. - signia still assumes that deriver functions are pure, and that if a deriver function throws once it will throw again unless its parent signals change value, so **it caches thrown errors for computed values** and throws them again if .get() is called again before the parents change - it clears the history buffer if an error is thrown - it does not allow errors to bubble during dirty checking i.e. inside `haveParentsChanged` or while calculating diffs. ### Change Type - [x] `patch` — Bug fix - [ ] `minor` — New feature - [ ] `major` — Breaking change - [ ] `dependencies` — Changes to package dependencies[^1] - [ ] `documentation` — Changes to the documentation only[^2] - [ ] `tests` — Changes to any test code only[^2] - [ ] `internal` — Any other changes that don't affect the published package[^2] - [ ] I don't know [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version ### Test Plan 1. Add a step-by-step description of how to test your PR here. 2. - [x] Unit Tests - [ ] End to end tests ### Release Notes - Add a brief release note for your PR here.
2024-02-14 13:32:15 +00:00
"text": "__unsafe__getWithoutCapture(ignoreErrors?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": "): "
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Content",
"text": "Value"
},
{
"kind": "Content",
"text": ";"
}
],
"isOptional": false,
"returnTypeTokenRange": {
Improve signia error handling (#2835) This PR revamps how errors in signia are handled. This was brought about by a situation that @MitjaBezensek encountered where he added a reactor to a shape util class. During fuzz tests, that reactor was being executed at times when the Editor was not in a usable state (we had a minor hole in our sync rebase logic that allowed this, fixed elsewhere) and the reactor was throwing errors because it dereferenced a parent signal that relied on the page state (getShapesInCurrentPage or whatever) when there were no page records in the store. The strange part was that even if we wrapped the body of the reactor function in a try/catch, ignoring the error, we'd still see the error bubble up somehow. That was because the error was being thrown in a Computed derive function, and those are evaluated independently (i.e. outside of the reactor function) by signia as it traverses the dependency graph from leaves to roots in the `haveParentsChanged()` internal function. So the immediate fix was to make it so that `haveParentsChanged` ignores errors somehow. But the better fix involved completely revamping how signia handles errors, and they work very much like how signia handles values now. i.e. - signia still assumes that deriver functions are pure, and that if a deriver function throws once it will throw again unless its parent signals change value, so **it caches thrown errors for computed values** and throws them again if .get() is called again before the parents change - it clears the history buffer if an error is thrown - it does not allow errors to bubble during dirty checking i.e. inside `haveParentsChanged` or while calculating diffs. ### Change Type - [x] `patch` — Bug fix - [ ] `minor` — New feature - [ ] `major` — Breaking change - [ ] `dependencies` — Changes to package dependencies[^1] - [ ] `documentation` — Changes to the documentation only[^2] - [ ] `tests` — Changes to any test code only[^2] - [ ] `internal` — Any other changes that don't affect the published package[^2] - [ ] I don't know [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version ### Test Plan 1. Add a step-by-step description of how to test your PR here. 2. - [x] Unit Tests - [ ] End to end tests ### Release Notes - Add a brief release note for your PR here.
2024-02-14 13:32:15 +00:00
"startIndex": 3,
"endIndex": 4
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
"releaseTag": "Public",
"overloadIndex": 1,
Improve signia error handling (#2835) This PR revamps how errors in signia are handled. This was brought about by a situation that @MitjaBezensek encountered where he added a reactor to a shape util class. During fuzz tests, that reactor was being executed at times when the Editor was not in a usable state (we had a minor hole in our sync rebase logic that allowed this, fixed elsewhere) and the reactor was throwing errors because it dereferenced a parent signal that relied on the page state (getShapesInCurrentPage or whatever) when there were no page records in the store. The strange part was that even if we wrapped the body of the reactor function in a try/catch, ignoring the error, we'd still see the error bubble up somehow. That was because the error was being thrown in a Computed derive function, and those are evaluated independently (i.e. outside of the reactor function) by signia as it traverses the dependency graph from leaves to roots in the `haveParentsChanged()` internal function. So the immediate fix was to make it so that `haveParentsChanged` ignores errors somehow. But the better fix involved completely revamping how signia handles errors, and they work very much like how signia handles values now. i.e. - signia still assumes that deriver functions are pure, and that if a deriver function throws once it will throw again unless its parent signals change value, so **it caches thrown errors for computed values** and throws them again if .get() is called again before the parents change - it clears the history buffer if an error is thrown - it does not allow errors to bubble during dirty checking i.e. inside `haveParentsChanged` or while calculating diffs. ### Change Type - [x] `patch` — Bug fix - [ ] `minor` — New feature - [ ] `major` — Breaking change - [ ] `dependencies` — Changes to package dependencies[^1] - [ ] `documentation` — Changes to the documentation only[^2] - [ ] `tests` — Changes to any test code only[^2] - [ ] `internal` — Any other changes that don't affect the published package[^2] - [ ] I don't know [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version ### Test Plan 1. Add a step-by-step description of how to test your PR here. 2. - [x] Unit Tests - [ ] End to end tests ### Release Notes - Add a brief release note for your PR here.
2024-02-14 13:32:15 +00:00
"parameters": [
{
"parameterName": "ignoreErrors",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": true
}
],
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"name": "__unsafe__getWithoutCapture"
},
Replace Atom.value with Atom.get() (#2189) This PR replaces the `.value` getter for the atom with `.get()` ### Change Type - [x] `major` — Breaking change --------- Co-authored-by: David Sheldrick <d.j.sheldrick@gmail.com>
2023-11-13 11:51:22 +00:00
{
"kind": "MethodSignature",
"canonicalReference": "@tldraw/state!Signal#get:member(1)",
"docComment": "/**\n * The current value of the signal. This is a reactive value, and will update when the signal changes. Any computed signal that depends on this signal will be lazily recomputed if this signal changes. Any effect that depends on this signal will be rescheduled if this signal changes.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "get(): "
},
{
"kind": "Content",
"text": "Value"
},
{
"kind": "Content",
"text": ";"
}
],
"isOptional": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "get"
},
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
{
"kind": "MethodSignature",
"canonicalReference": "@tldraw/state!Signal#getDiffSince:member(1)",
"docComment": "/**\n * Returns the sequence of diffs between the the value at the given epoch and the current value. Returns the [[RESET_VALUE]] constant if there is not enough information to compute the diff sequence.\n *\n * @param epoch - The epoch to get diffs since.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "getDiffSince(epoch: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "Diff[] | "
},
{
"kind": "Reference",
"text": "RESET_VALUE",
"canonicalReference": "@tldraw/state!RESET_VALUE:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isOptional": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "epoch",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"name": "getDiffSince"
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/state!Signal#lastChangedEpoch:member",
"docComment": "/**\n * The epoch when this signal's value last changed. Note tha this is not the same as when the value was last computed. A signal may recopmute it's value without changing it.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "lastChangedEpoch: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "lastChangedEpoch",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@tldraw/state!Signal#name:member",
"docComment": "/**\n * The name of the signal. This is used at runtime for debugging and perf profiling only. It does not need to be globally unique.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "name: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isReadonly": false,
"isOptional": false,
"releaseTag": "Public",
"name": "name",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Function",
"canonicalReference": "@tldraw/state!track:function(1)",
Replace getters in examples (#2261) Follow up to #2189 ### Change Type - [ ] `patch` — Bug fix - [ ] `minor` — New feature - [ ] `major` — Breaking change - [ ] `dependencies` — Changes to package dependencies[^1] - [x] `documentation` — Changes to the documentation only[^2] - [ ] `tests` — Changes to any test code only[^2] - [ ] `internal` — Any other changes that don't affect the published package[^2] - [ ] I don't know [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-11-28 17:33:10 +00:00
"docComment": "/**\n * Returns a tracked version of the given component. Any signals whose values are read while the component renders will be tracked. If any of the tracked signals change later it will cause the component to re-render.\n *\n * This also wraps the component in a React.memo() call, so it will only re-render if the props change.\n *\n * @param baseComponent - The base component to track.\n *\n * @example\n * ```ts\n * const Counter = track(function Counter(props: CounterProps) {\n * const count = useAtom('count', 0)\n * const increment = useCallback(() => count.set(count.get() + 1), [count])\n * return <button onClick={increment}>{count.get()}</button>\n * })\n * ```\n *\n * @public\n */\n",
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function track<T extends "
},
{
"kind": "Reference",
"text": "FunctionComponent",
"canonicalReference": "@types/react!React.FunctionComponent:interface"
},
{
"kind": "Content",
"text": "<any>"
},
{
"kind": "Content",
"text": ">(baseComponent: "
},
{
"kind": "Content",
"text": "T"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "T extends "
},
{
"kind": "Reference",
"text": "React.MemoExoticComponent",
"canonicalReference": "@types/react!React.MemoExoticComponent:type"
},
{
"kind": "Content",
"text": "<any> ? T : "
},
{
"kind": "Reference",
"text": "React.MemoExoticComponent",
"canonicalReference": "@types/react!React.MemoExoticComponent:type"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/state/src/lib/react/track.ts",
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "baseComponent",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
},
"isOptional": false
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "track"
},
{
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"kind": "Function",
"canonicalReference": "@tldraw/state!transact:function(1)",
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"docComment": "/**\n * Like [transaction](#transaction), but does not create a new transaction if there is already one in progress.\n *\n * @param fn - The function to run in a transaction.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "export declare function transact<T>(fn: "
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Content",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "() => T"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "T"
},
{
"kind": "Content",
"text": ";"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
}
],
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"fileUrlPath": "packages/state/src/lib/core/transactions.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"releaseTag": "Public",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"overloadIndex": 1,
"parameters": [
{
"parameterName": "fn",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "transact"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"kind": "Function",
"canonicalReference": "@tldraw/state!transaction:function(1)",
Replace getters in examples (#2261) Follow up to #2189 ### Change Type - [ ] `patch` — Bug fix - [ ] `minor` — New feature - [ ] `major` — Breaking change - [ ] `dependencies` — Changes to package dependencies[^1] - [x] `documentation` — Changes to the documentation only[^2] - [ ] `tests` — Changes to any test code only[^2] - [ ] `internal` — Any other changes that don't affect the published package[^2] - [ ] I don't know [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-11-28 17:33:10 +00:00
"docComment": "/**\n * Batches state updates, deferring side effects until after the transaction completes.\n *\n * @param fn - The function to run in a transaction, called with a function to roll back the change.\n *\n * @example\n * ```ts\n * const firstName = atom('John')\n * const lastName = atom('Doe')\n *\n * react('greet', () => {\n * print(`Hello, ${firstName.get()} ${lastName.get()}!`)\n * })\n *\n * // Logs \"Hello, John Doe!\"\n *\n * transaction(() => {\n * firstName.set('Jane')\n * lastName.set('Smith')\n * })\n *\n * // Logs \"Hello, Jane Smith!\"\n * ```\n *\n * If the function throws, the transaction is aborted and any signals that were updated during the transaction revert to their state before the transaction began.\n *\n * @example\n * ```ts\n * const firstName = atom('John')\n * const lastName = atom('Doe')\n *\n * react('greet', () => {\n * print(`Hello, ${firstName.get()} ${lastName.get()}!`)\n * })\n *\n * // Logs \"Hello, John Doe!\"\n *\n * transaction(() => {\n * firstName.set('Jane')\n * throw new Error('oops')\n * })\n *\n * // Does not log\n * // firstName.get() === 'John'\n * ```\n *\n * A `rollback` callback is passed into the function. Calling this will prevent the transaction from committing and will revert any signals that were updated during the transaction to their state before the transaction began.\n *\n * *\n *\n * @example\n * ```ts\n * const firstName = atom('John')\n * const lastName = atom('Doe')\n *\n * react('greet', () => {\n * print(`Hello, ${firstName.get()} ${lastName.get()}!`)\n * })\n *\n * // Logs \"Hello, John Doe!\"\n *\n * transaction((rollback) => {\n * firstName.set('Jane')\n * lastName.set('Smith')\n * rollback()\n * })\n *\n * // Does not log\n * // firstName.get() === 'John'\n * // lastName.get() === 'Doe'\n * ```\n *\n * @public\n */\n",
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"excerptTokens": [
{
"kind": "Content",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "export declare function transaction<T>(fn: "
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Content",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "(rollback: () => void) => T"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "T"
},
{
"kind": "Content",
"text": ";"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
}
],
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"fileUrlPath": "packages/state/src/lib/core/transactions.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"releaseTag": "Public",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"overloadIndex": 1,
"parameters": [
{
"parameterName": "fn",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "transaction"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"kind": "Function",
"canonicalReference": "@tldraw/state!unsafe__withoutCapture:function(1)",
Replace getters in examples (#2261) Follow up to #2189 ### Change Type - [ ] `patch` — Bug fix - [ ] `minor` — New feature - [ ] `major` — Breaking change - [ ] `dependencies` — Changes to package dependencies[^1] - [x] `documentation` — Changes to the documentation only[^2] - [ ] `tests` — Changes to any test code only[^2] - [ ] `internal` — Any other changes that don't affect the published package[^2] - [ ] I don't know [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-11-28 17:33:10 +00:00
"docComment": "/**\n * Executes the given function without capturing any parents in the current capture context.\n *\n * This is mainly useful if you want to run an effect only when certain signals change while also dereferencing other signals which should not cause the effect to rerun on their own.\n *\n * @example\n * ```ts\n * const name = atom('name', 'Sam')\n * const time = atom('time', () => new Date().getTime())\n *\n * setInterval(() => {\n * time.set(new Date().getTime())\n * })\n *\n * react('log name changes', () => {\n * \t print(name.get(), 'was changed at', unsafe__withoutCapture(() => time.get()))\n * })\n *\n * ```\n *\n * @public\n */\n",
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"excerptTokens": [
{
"kind": "Content",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "export declare function unsafe__withoutCapture<T>(fn: "
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Content",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "() => T"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "T"
},
{
"kind": "Content",
"text": ";"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
}
],
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"fileUrlPath": "packages/state/src/lib/core/capture.ts",
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"releaseTag": "Public",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"overloadIndex": 1,
"parameters": [
{
"parameterName": "fn",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "unsafe__withoutCapture"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Function",
"canonicalReference": "@tldraw/state!useAtom:function(1)",
Replace getters in examples (#2261) Follow up to #2189 ### Change Type - [ ] `patch` — Bug fix - [ ] `minor` — New feature - [ ] `major` — Breaking change - [ ] `dependencies` — Changes to package dependencies[^1] - [x] `documentation` — Changes to the documentation only[^2] - [ ] `tests` — Changes to any test code only[^2] - [ ] `internal` — Any other changes that don't affect the published package[^2] - [ ] I don't know [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-11-28 17:33:10 +00:00
"docComment": "/**\n * Creates a new atom and returns it. The atom will be created only once.\n *\n * See [[atom]]\n *\n * @example\n * ```ts\n * const Counter = track(function Counter () {\n * const count = useAtom('count', 0)\n * const increment = useCallback(() => count.set(count.get() + 1), [count])\n * return <button onClick={increment}>{count.get()}</button>\n * })\n * ```\n *\n * @public\n */\n",
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useAtom<Value, Diff = "
},
{
"kind": "Content",
"text": "unknown"
},
{
"kind": "Content",
"text": ">(\nname: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", \nvalueOrInitialiser: "
},
{
"kind": "Content",
Add white migration (#3334) This PR adds a down migration for #3321. ### Change Type - [x] `sdk` — Changes the tldraw SDK - [x] `dunno` — I don't know
2024-04-04 18:16:17 +00:00
"text": "(() => Value) | Value"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Content",
"text": ", \noptions?: "
},
{
"kind": "Reference",
"text": "AtomOptions",
"canonicalReference": "@tldraw/state!AtomOptions:interface"
},
{
"kind": "Content",
"text": "<Value, Diff>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Atom",
"canonicalReference": "@tldraw/state!Atom:interface"
},
{
"kind": "Content",
"text": "<Value, Diff>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/state/src/lib/react/useAtom.ts",
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 12
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "name",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
},
{
"parameterName": "valueOrInitialiser",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"isOptional": false
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 9
},
"isOptional": true
}
],
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "Diff",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "useAtom"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/state!useComputed:function(1)",
Replace getters in examples (#2261) Follow up to #2189 ### Change Type - [ ] `patch` — Bug fix - [ ] `minor` — New feature - [ ] `major` — Breaking change - [ ] `dependencies` — Changes to package dependencies[^1] - [x] `documentation` — Changes to the documentation only[^2] - [ ] `tests` — Changes to any test code only[^2] - [ ] `internal` — Any other changes that don't affect the published package[^2] - [ ] I don't know [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-11-28 17:33:10 +00:00
"docComment": "/**\n * Creates a new computed signal and returns it. The computed signal will be created only once.\n *\n * See [[computed]]\n *\n * @example\n * ```ts\n * type GreeterProps = {\n * firstName: Signal<string>\n * lastName: Signal<string>\n * }\n *\n * const Greeter = track(function Greeter ({firstName, lastName}: GreeterProps) {\n * const fullName = useComputed('fullName', () => `${firstName.get()} ${lastName.get()}`)\n * return <div>Hello {fullName.get()}!</div>\n * })\n * ```\n *\n * @public\n */\n",
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useComputed<Value>(name: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", compute: "
},
{
"kind": "Content",
"text": "() => Value"
},
{
"kind": "Content",
"text": ", deps: "
},
{
"kind": "Content",
"text": "any[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Computed",
"canonicalReference": "@tldraw/state!Computed:interface"
},
{
"kind": "Content",
"text": "<Value>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/state/src/lib/react/useComputed.ts",
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 9
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "name",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "compute",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
},
{
"parameterName": "deps",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"isOptional": false
}
],
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "useComputed"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/state!useComputed:function(2)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useComputed<Value, Diff = "
},
{
"kind": "Content",
"text": "unknown"
},
{
"kind": "Content",
"text": ">(name: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", compute: "
},
{
"kind": "Content",
"text": "() => Value"
},
{
"kind": "Content",
"text": ", opts: "
},
{
"kind": "Reference",
"text": "ComputedOptions",
"canonicalReference": "@tldraw/state!ComputedOptions:interface"
},
{
"kind": "Content",
"text": "<Value, Diff>"
},
{
"kind": "Content",
"text": ", deps: "
},
{
"kind": "Content",
"text": "any[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Computed",
"canonicalReference": "@tldraw/state!Computed:interface"
},
{
"kind": "Content",
"text": "<Value>"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/state/src/lib/react/useComputed.ts",
"returnTypeTokenRange": {
"startIndex": 12,
"endIndex": 14
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "name",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
},
{
"parameterName": "compute",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"isOptional": false
},
{
"parameterName": "opts",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 9
},
"isOptional": false
},
{
"parameterName": "deps",
"parameterTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"isOptional": false
}
],
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "Diff",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "useComputed"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/state!useQuickReactor:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useQuickReactor(name: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", reactFn: "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": ", deps?: "
},
{
"kind": "Content",
"text": "any[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/state/src/lib/react/useQuickReactor.ts",
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "name",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "reactFn",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
},
{
"parameterName": "deps",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"isOptional": true
}
],
"name": "useQuickReactor"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/state!useReactor:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useReactor(name: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", reactFn: "
},
{
"kind": "Content",
"text": "() => void"
},
{
"kind": "Content",
"text": ", deps?: "
},
{
"kind": "Content",
Add white migration (#3334) This PR adds a down migration for #3321. ### Change Type - [x] `sdk` — Changes the tldraw SDK - [x] `dunno` — I don't know
2024-04-04 18:16:17 +00:00
"text": "any[] | undefined"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/state/src/lib/react/useReactor.ts",
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "name",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "reactFn",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
},
{
"parameterName": "deps",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"isOptional": true
}
],
"name": "useReactor"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/state!useValue:function(1)",
Replace getters in examples (#2261) Follow up to #2189 ### Change Type - [ ] `patch` — Bug fix - [ ] `minor` — New feature - [ ] `major` — Breaking change - [ ] `dependencies` — Changes to package dependencies[^1] - [x] `documentation` — Changes to the documentation only[^2] - [ ] `tests` — Changes to any test code only[^2] - [ ] `internal` — Any other changes that don't affect the published package[^2] - [ ] I don't know [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-11-28 17:33:10 +00:00
"docComment": "/**\n * Extracts the value from a signal and subscribes to it.\n *\n * Note that you do not need to use this hook if you are wrapping the component with [[track]]\n *\n * @example\n * ```ts\n * const Counter: React.FC = () => {\n * const $count = useAtom('count', 0)\n * const increment = useCallback(() => $count.set($count.get() + 1), [count])\n * const currentCount = useValue($count)\n * return <button onClick={increment}>{currentCount}</button>\n * }\n * ```\n *\n * You can also pass a function to compute the value and it will be memoized as in [[useComputed]]:\n *\n * @example\n * ```ts\n * type GreeterProps = {\n * firstName: Signal<string>\n * lastName: Signal<string>\n * }\n *\n * const Greeter = track(function Greeter({ firstName, lastName }: GreeterProps) {\n * const fullName = useValue('fullName', () => `${firstName.get()} ${lastName.get()}`, [\n * firstName,\n * lastName,\n * ])\n * return <div>Hello {fullName}!</div>\n * })\n * ```\n *\n * @public\n */\n",
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useValue<Value>(value: "
},
{
"kind": "Reference",
"text": "Signal",
"canonicalReference": "@tldraw/state!Signal:interface"
},
{
"kind": "Content",
"text": "<Value>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "Value"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/state/src/lib/react/useValue.ts",
"returnTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"isOptional": false
}
],
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "useValue"
},
{
"kind": "Function",
"canonicalReference": "@tldraw/state!useValue:function(2)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function useValue<Value>(name: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", fn: "
},
{
"kind": "Content",
"text": "() => Value"
},
{
"kind": "Content",
"text": ", deps: "
},
{
"kind": "Content",
"text": "unknown[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "Value"
},
{
"kind": "Content",
"text": ";"
}
],
"fileUrlPath": "packages/state/src/lib/react/useValue.ts",
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "name",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "fn",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
},
{
"parameterName": "deps",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"isOptional": false
}
],
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "useValue"
},
{
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"kind": "Function",
"canonicalReference": "@tldraw/state!whyAmIRunning:function(1)",
Replace getters in examples (#2261) Follow up to #2189 ### Change Type - [ ] `patch` — Bug fix - [ ] `minor` — New feature - [ ] `major` — Breaking change - [ ] `dependencies` — Changes to package dependencies[^1] - [x] `documentation` — Changes to the documentation only[^2] - [ ] `tests` — Changes to any test code only[^2] - [ ] `internal` — Any other changes that don't affect the published package[^2] - [ ] I don't know [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-11-28 17:33:10 +00:00
"docComment": "/**\n * A debugging tool that tells you why a computed signal or effect is running. Call in the body of a computed signal or effect function.\n *\n * @example\n * ```ts\n * const name = atom('name', 'Bob')\n * react('greeting', () => {\n * \twhyAmIRunning()\n * \tprint('Hello', name.get())\n * })\n *\n * name.set('Alice')\n *\n * // 'greeting' is running because:\n * // 'name' changed => 'Alice'\n * ```\n *\n * @public\n */\n",
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"excerptTokens": [
{
"kind": "Content",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "export declare function whyAmIRunning(): "
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Content",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "void"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"kind": "Content",
"text": ";"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
}
],
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"fileUrlPath": "packages/state/src/lib/core/capture.ts",
"returnTypeTokenRange": {
Use a global singleton for tlstate (#2322) One minor issue with signia is that it uses global state for bookkeeping, so it is potentially disastrous if there is more than one version of it included in a bundle. To prevent that being an issue before we had a warning that would trigger if signia detects multiple initializations. > Multiple versions of @tldraw/state detected. This will cause unexpected behavior. Please add "resolutions" (yarn/pnpm) or "overrides" (npm) in your package.json to ensure only one version of @tldraw/state is loaded. Alas I think this warning triggers too often in development environments, e.g. during HMR or janky bundlers. Something that can prevent the need for this particular warning is having a global singleton version of signia that we only instantiate once, and then re-use that one on subsequent module initializations. We didn't do this before because it has a few downsides: - breaks HMR if you are working on signia itself, since updated modules won't be used and you'll need to do a full refresh. - introduces the possibility of breakage if we remove or even add APIs to signia. We can't rely on having the latest version of signia be the first to instantiate, and we can't allow later instantiations to take precedence since atoms n stuff may have already been created with the prior version. To mitigate this I've introduced a `apiVersion` const that we can increment when we make any kind of additions or removals. If there is a mismatch between the `apiVersion` in the global singleton vs the currently-initializing module, then it throws. Ultimately i think the pros outweigh the cons here, i.e. far fewer people will see and have to deal with the error message shown above, and fewer people should encounter a situation where the editor appears to load but nothing changes when you interact with it. ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version ### Release Notes - Make a global singleton for tlstate.
2023-12-14 13:35:34 +00:00
"startIndex": 1,
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "whyAmIRunning"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"kind": "Function",
"canonicalReference": "@tldraw/state!withDiff:function(1)",
Replace getters in examples (#2261) Follow up to #2189 ### Change Type - [ ] `patch` — Bug fix - [ ] `minor` — New feature - [ ] `major` — Breaking change - [ ] `dependencies` — Changes to package dependencies[^1] - [x] `documentation` — Changes to the documentation only[^2] - [ ] `tests` — Changes to any test code only[^2] - [ ] `internal` — Any other changes that don't affect the published package[^2] - [ ] I don't know [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-11-28 17:33:10 +00:00
"docComment": "/**\n * When writing incrementally-computed signals it is convenient (and usually more performant) to incrementally compute the diff too.\n *\n * You can use this function to wrap the return value of a computed signal function to indicate that the diff should be used instead of calculating a new one with [[AtomOptions.computeDiff]].\n *\n * @param value - The value.\n *\n * @param diff - The diff.\n *\n * @example\n * ```ts\n * const count = atom('count', 0)\n * const double = computed('double', (prevValue) => {\n * const nextValue = count.get() * 2\n * if (isUninitialized(prevValue)) {\n * return nextValue\n * }\n * return withDiff(nextValue, nextValue - prevValue)\n * }, { historyLength: 10 })\n * ```\n *\n * @public\n */\n",
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"excerptTokens": [
{
"kind": "Content",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "export declare function withDiff<Value, Diff>(value: "
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Content",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "Value"
},
{
"kind": "Content",
"text": ", diff: "
},
{
"kind": "Content",
"text": "Diff"
},
{
"kind": "Content",
"text": "): "
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
},
{
"kind": "Reference",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"text": "WithDiff",
"canonicalReference": "@tldraw/state!~WithDiff:type"
},
{
"kind": "Content",
"text": "<Value, Diff>"
},
{
"kind": "Content",
"text": ";"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
}
],
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"fileUrlPath": "packages/state/src/lib/core/Computed.ts",
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 7
},
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
"releaseTag": "Public",
Fix TSDoc for @tldraw/state (#2327) This PR opts to split the big singleton out into other smaller singletons so that we can revert the moving of the tsdoc comments that happened in #2322 ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version
2023-12-18 10:57:37 +00:00
"overloadIndex": 1,
"parameters": [
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isOptional": false
},
{
"parameterName": "diff",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isOptional": false
}
],
"typeParameters": [
{
"typeParameterName": "Value",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "Diff",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "withDiff"
Publish api.json (#2034) This PR publishes the api.json files created by the build-api scripts. ### Change Type - [x] `internal`
2023-10-08 15:00:58 +00:00
}
]
}
]
}
Reference in a new issue Copy permalink