|
128 | 128 | --- built-in type for Rawget |
129 | 129 | --- @alias std.RawGet<T, K> unknown |
130 | 130 |
|
| 131 | +--- built-in type for generic template, for match integer const and `true`/`false` |
131 | 132 | --- @deprecated use `const T` as a replacement, for example `---@generic const T`. |
132 | | ---- |
133 | | ---- built-in type for generic template, for match integer const and true/false |
134 | 133 | --- @alias std.ConstTpl<T> unknown |
135 | 134 |
|
136 | 135 | --- compact luals |
|
171 | 170 |
|
172 | 171 | --- attribute |
173 | 172 |
|
| 173 | +--- @class Attribute |
| 174 | + |
174 | 175 | --- |
175 | 176 | --- Deprecated. Receives an optional message parameter. |
176 | | ---- @attribute deprecated(message: string?) |
| 177 | +--- @class deprecated: Attribute |
| 178 | +--- @overload fun(message?: string) |
177 | 179 |
|
178 | 180 | --- |
179 | 181 | --- Language Server Optimization Items. |
180 | 182 | --- |
181 | 183 | --- Parameters: |
182 | | ---- - `check_table_field`: Skip the assign check for table fields. It is recommended to use this option for all large configuration tables. |
| 184 | +--- - `skip_table_fields_check`: Skip table field diagnostics. It is recommended to use this option for all large configuration tables. |
183 | 185 | --- - `delayed_definition`: Indicates that the type of the variable is determined by the first assignment. |
184 | 186 | --- Only valid for `local` declarations with no initial value. |
185 | | ---- @attribute lsp_optimization(code: "check_table_field"|"delayed_definition") |
| 187 | +--- @class lsp_optimization: Attribute |
| 188 | +--- @overload fun(code: "skip_table_fields_check"|"delayed_definition") |
186 | 189 |
|
187 | 190 | --- |
188 | 191 | --- Index field alias, will be displayed in `hint` and `completion`. |
189 | 192 | --- |
190 | 193 | --- Receives a string parameter for the alias name. |
191 | | ---- @attribute index_alias(name: string) |
| 194 | +--- @class index_alias: Attribute |
| 195 | +--- @overload fun(name: string) |
192 | 196 |
|
193 | 197 | --- |
194 | 198 | --- This attribute must be applied to function parameters, and the function parameter's type must be a string template generic, |
|
201 | 205 | --- - `return_mode`: Constructor return strategy. `"self"` forces `self`, `"doc"` uses the documented return type, |
202 | 206 | --- and `"default"` prefers the documented return type and falls back to `self`. |
203 | 207 | --- Defaults to `"default"` |
204 | | ---- @attribute constructor(name: string, root_class: string?, strip_self: boolean?, return_mode: "self"|"doc"|"default"?) |
| 208 | +--- @class constructor: Attribute |
| 209 | +--- @overload fun(name: string, root_class?: string, strip_self?: boolean, return_mode?: "self"|"doc"|"default") |
205 | 210 |
|
206 | 211 | --- |
207 | 212 | --- Associates `getter` and `setter` methods with a field. Currently provides only definition navigation functionality, |
|
211 | 216 | --- - `convention`: Naming convention, defaults to `camelCase`. Implicitly adds `get` and `set` prefixes. eg: `_age` -> `getAge`, `setAge`. |
212 | 217 | --- - `getter`: Getter method name. Takes precedence over `convention`. |
213 | 218 | --- - `setter`: Setter method name. Takes precedence over `convention`. |
214 | | ---- @attribute field_accessor(convention: "camelCase"|"PascalCase"|"snake_case"|nil, getter: string?, setter: string?) |
| 219 | +--- @class field_accessor: Attribute |
| 220 | +--- @overload fun(convention?: "camelCase"|"PascalCase"|"snake_case", getter?: string, setter?: string) |
0 commit comments