Skip to content
Source
Sign inSign up
TanStack/store
Open History to see the last commit

InternalReadonlyAtom.md

170 lines2.5 KB

1---
2id: InternalReadonlyAtom
3title: InternalReadonlyAtom
4---
5​
6Defined in: [types.ts:53](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L53)
7​
8## Extends
9​
10- [`InternalBaseAtom`](InternalBaseAtom.md)\<`T`\>.`ReactiveNode`
11​
12## Type Parameters
13​
14### T
15​
16`T`
17​
18## Properties
19​
20### \_snapshot
21​
22```ts
23_snapshot: T;
24```
25​
26Defined in: [types.ts:37](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L37)
27​
28**`Internal`**
29​
30#### Inherited from
31​
32[`InternalBaseAtom`](InternalBaseAtom.md).[`_snapshot`](InternalBaseAtom.md#_snapshot)
33​
34***
35​
36### \_update
37​
38```ts
39_update: (getValue?) => boolean;
40```
41​
42Defined in: [types.ts:39](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L39)
43​
44**`Internal`**
45​
46#### Parameters
47​
48##### getValue?
49​
50`T` \| ((`snapshot`) => `T`)
51​
52#### Returns
53​
54`boolean`
55​
56#### Inherited from
57​
58[`InternalBaseAtom`](InternalBaseAtom.md).[`_update`](InternalBaseAtom.md#_update)
59​
60***
61​
62### deps?
63​
64```ts
65optional deps?: Link;
66```
67​
68Defined in: [alien.ts:6](https://github.com/TanStack/store/blob/main/packages/store/src/alien.ts#L6)
69​
70#### Inherited from
71​
72```ts
73ReactiveNode.deps
74```
75​
76***
77​
78### depsTail?
79​
80```ts
81optional depsTail?: Link;
82```
83​
84Defined in: [alien.ts:7](https://github.com/TanStack/store/blob/main/packages/store/src/alien.ts#L7)
85​
86#### Inherited from
87​
88```ts
89ReactiveNode.depsTail
90```
91​
92***
93​
94### flags
95​
96```ts
97flags: number;
98```
99​
100Defined in: [alien.ts:10](https://github.com/TanStack/store/blob/main/packages/store/src/alien.ts#L10)
101​
102#### Inherited from
103​
104```ts
105ReactiveNode.flags
106```
107​
108***
109​
110### get
111​
112```ts
113get: () => T;
114```
115​
116Defined in: [types.ts:30](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L30)
117​
118#### Returns
119​
120`T`
121​
122#### Inherited from
123​
124[`InternalBaseAtom`](InternalBaseAtom.md).[`get`](InternalBaseAtom.md#get)
125​
126***
127​
128### subs?
129​
130```ts
131optional subs?: Link;
132```
133​
134Defined in: [alien.ts:8](https://github.com/TanStack/store/blob/main/packages/store/src/alien.ts#L8)
135​
136#### Inherited from
137​
138```ts
139ReactiveNode.subs
140```
141​
142***
143​
144### subscribe
145​
146```ts
147subscribe: (observer) => Subscription & (next, error?, complete?) => Subscription;
148```
149​
150Defined in: [types.ts:21](https://github.com/TanStack/store/blob/main/packages/store/src/types.ts#L21)
151​
152#### Inherited from
153​
154[`InternalBaseAtom`](InternalBaseAtom.md).[`subscribe`](InternalBaseAtom.md#subscribe)
155​
156***
157​
158### subsTail?
159​
160```ts
161optional subsTail?: Link;
162```
163​
164Defined in: [alien.ts:9](https://github.com/TanStack/store/blob/main/packages/store/src/alien.ts#L9)
165​
166#### Inherited from
167​
168```ts
169ReactiveNode.subsTail
170```