@alloy-js/csharp 0.23.0-dev.1 → 0.23.0-dev.10

package/docs/api/functions/makeModifiers.md

@@ -0,0 +1,18 @@
+# makeModifiers
+
+```ts
+import { makeModifiers } from "@alloy-js/csharp";
+
+
+function makeModifiers<T>(obj: Array<keyof T>): (data: T) => string;
+```
+
+## Parameters
+
+|     |                 |   |
+| --- | --------------- | - |
+| obj | Array\<keyof T> |   |
+
+## Returns
+
+(data: T) => string

package/docs/api/functions/nonAccessibilityFromProps.md

@@ -0,0 +1,18 @@
+# nonAccessibilityFromProps
+
+```ts
+import { nonAccessibilityFromProps } from "@alloy-js/csharp";
+
+
+function nonAccessibilityFromProps(props: NonAccessModifiers): CSharpSymbolOptions;
+```
+
+## Parameters
+
+|       |                    |   |
+| ----- | ------------------ | - |
+| props | NonAccessModifiers |   |
+
+## Returns
+
+[CSharpSymbolOptions](../../types/csharpsymboloptions/)

package/docs/api/functions/ref.md

@@ -0,0 +1,18 @@
+# ref
+
+```ts
+import { ref } from "@alloy-js/csharp";
+
+
+function ref(refkey: Refkey): () => [Children, OutputSymbol | undefined];
+```
+
+## Parameters
+
+|        |        |   |
+| ------ | ------ | - |
+| refkey | Refkey |   |
+
+## Returns
+
+() => \[[Children](../../../core/types/children/), [OutputSymbol](../../../core/types/outputsymbol/) | undefined]

package/docs/api/functions/useCSharpNamePolicy.md

@@ -0,0 +1,17 @@
+# useCSharpNamePolicy
+
+```ts
+import { useCSharpNamePolicy } from "@alloy-js/csharp";
+
+
+function useCSharpNamePolicy(): core.NamePolicy<CSharpElements>;
+```
+
+## Parameters
+
+|   |
+| - |
+
+## Returns
+
+[NamePolicy](../../../core/types/namepolicy/)<[CSharpElements](../../types/csharpelements/)>

package/docs/api/functions/useCSharpScope.md

@@ -0,0 +1,17 @@
+# useCSharpScope
+
+```ts
+import { useCSharpScope } from "@alloy-js/csharp";
+
+
+function useCSharpScope(): CSharpScope;
+```
+
+## Parameters
+
+|   |
+| - |
+
+## Returns
+
+[CSharpScope](../../types/csharpscope/)

package/docs/api/functions/useCsharpFormatOptions.md

@@ -0,0 +1,18 @@
+# useCsharpFormatOptions
+
+```ts
+import { useCsharpFormatOptions } from "@alloy-js/csharp";
+
+
+useCsharpFormatOptions: (overrides?: Partial<CSharpFormatOptions> | undefined) => CSharpFormatOptions
+```
+
+## Parameters
+
+|           |                                                     |   |
+| --------- | --------------------------------------------------- | - |
+| overrides | optional Partial\<CSharpFormatOptions> \| undefined |   |
+
+## Returns
+
+[CSharpFormatOptions](../../types/csharpformatoptions/)

package/docs/api/functions/useEnclosingNamespaceScope.md

@@ -0,0 +1,17 @@
+# useEnclosingNamespaceScope
+
+```ts
+import { useEnclosingNamespaceScope } from "@alloy-js/csharp";
+
+
+function useEnclosingNamespaceScope(): CSharpNamespaceScope | undefined;
+```
+
+## Parameters
+
+|   |
+| - |
+
+## Returns
+
+[CSharpNamespaceScope](../../types/csharpnamespacescope/) | undefined

package/docs/api/functions/useLexicalScope.md

@@ -0,0 +1,17 @@
+# useLexicalScope
+
+```ts
+import { useLexicalScope } from "@alloy-js/csharp";
+
+
+function useLexicalScope(): CSharpLexicalScope;
+```
+
+## Parameters
+
+|   |
+| - |
+
+## Returns
+
+[CSharpLexicalScope](../../types/csharplexicalscope/)

package/docs/api/functions/useMethodScope.md

@@ -0,0 +1,17 @@
+# useMethodScope
+
+```ts
+import { useMethodScope } from "@alloy-js/csharp";
+
+
+function useMethodScope(): CSharpMethodScope;
+```
+
+## Parameters
+
+|   |
+| - |
+
+## Returns
+
+[CSharpMethodScope](../../types/csharpmethodscope/)

package/docs/api/functions/useNamedTypeScope.md

@@ -0,0 +1,17 @@
+# useNamedTypeScope
+
+```ts
+import { useNamedTypeScope } from "@alloy-js/csharp";
+
+
+function useNamedTypeScope(): CSharpNamedTypeScope;
+```
+
+## Parameters
+
+|   |
+| - |
+
+## Returns
+
+[CSharpNamedTypeScope](../../types/csharpnamedtypescope/)

package/docs/api/functions/useNamespace.md

@@ -0,0 +1,17 @@
+# useNamespace
+
+```ts
+import { useNamespace } from "@alloy-js/csharp";
+
+
+function useNamespace(): CSharpNamespaceScope;
+```
+
+## Parameters
+
+|   |
+| - |
+
+## Returns
+
+[CSharpNamespaceScope](../../types/csharpnamespacescope/)

package/docs/api/functions/useSourceFileScope.md

@@ -0,0 +1,17 @@
+# useSourceFileScope
+
+```ts
+import { useSourceFileScope } from "@alloy-js/csharp";
+
+
+function useSourceFileScope(): CSharpSourceFileScope | undefined;
+```
+
+## Parameters
+
+|   |
+| - |
+
+## Returns
+
+[CSharpSourceFileScope](../../types/csharpsourcefilescope/) | undefined

package/docs/api/index.md

@@ -0,0 +1,6 @@
+# @alloy-js/csharp API Reference
+
+- [components](components/index.md) (53 items)
+- [functions](functions/index.md) (31 items)
+- [types](types/index.md) (60 items)
+- [variables](variables/index.md) (1 items)

package/docs/api/types/AccessExpressionBuilder.md

@@ -0,0 +1,11 @@
+# AccessExpressionBuilder
+
+## Members
+
+|               |                                                                                               |   |
+| ------------- | --------------------------------------------------------------------------------------------- | - |
+| \[RENDERABLE] | () => Children                                                                                |   |
+| call          | (member: Refkeyable \| string, args: Children\[], options: AccessExpressionPartProps) => this |   |
+| call          | (args: Children\[], options: AccessExpressionPartProps) => this                               |   |
+| index         | (indexerArgs: Children\[], options: AccessExpressionPartProps) => this                        |   |
+| member        | (member: Refkeyable \| string \| CSharpSymbol, options: AccessExpressionPartProps) => this    |   |

package/docs/api/types/AccessExpressionPartProps.md

@@ -0,0 +1,17 @@
+# AccessExpressionPartProps
+
+## Members
+
+|             |                                                                  |                                                                                                                                                                                                                           |
+| ----------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| args        | optional boolean \| [Children](../../../core/types/children/)\[] | Emit a function call.                                                                                                                                                                                                     |
+| attribute   | optional boolean                                                 | Wether this part is an attribute reference (used in an attribute context). In that case the “Attribute” suffix is trimmed from the name if present.                                                                       |
+| children    | optional [Children](../../../core/types/children/)               |                                                                                                                                                                                                                           |
+| conditional | optional boolean                                                 | Whether this part should use conditional access.                                                                                                                                                                          |
+| id          | optional string                                                  | The identifier to use for this part.                                                                                                                                                                                      |
+| index       | optional [Children](../../../core/types/children/)               | Create an element access part with a single indexer argument. Mutually exclusive with the `indexerArgs` prop.                                                                                                             |
+| indexerArgs | optional [Children](../../../core/types/children/)\[]            | Create an element access part with multiple indexer arguments. Mutually exclusive with the `index` prop.                                                                                                                  |
+| nullable    | optional boolean                                                 | Whether this part could possibly be null. Will guard member and element access with a conditional access operator. Passing this is not necessary if you provide a symbol or refkey and the symbol’s nullable flag is set. |
+| refkey      | optional [Refkeyable](../../../core/types/refkeyable/)           | A refkey for the symbol whose name becomes this part’s identifier. When a refkey is provided for the first part, it will be fully resolved. Otherwise, just the symbol’s name is used.                                    |
+| symbol      | optional [CSharpSymbol](../csharpsymbol/)                        | The symbol whose name becomes this part’s identifier.                                                                                                                                                                     |
+| typeArgs    | optional [Children](../../../core/types/children/)\[]            | Type arguments to pass to a member access.                                                                                                                                                                                |

package/docs/api/types/AccessModifiers.md

@@ -0,0 +1,13 @@
+# AccessModifiers
+
+Access modifiers.
+
+## Members
+
+|           |                  |   |
+| --------- | ---------------- | - |
+| file      | optional boolean |   |
+| internal  | optional boolean |   |
+| private   | optional boolean |   |
+| protected | optional boolean |   |
+| public    | optional boolean |   |

package/docs/api/types/AttributeProps.md

@@ -0,0 +1,8 @@
+# AttributeProps
+
+## Members
+
+|      |                                                         |                |
+| ---- | ------------------------------------------------------- | -------------- |
+| args | optional [Children](../../../core/types/children/)\[]   | Argument       |
+| name | string \| [Refkeyable](../../../core/types/refkeyable/) | Attribute name |

package/docs/api/types/AttributesProp.md

@@ -0,0 +1,5 @@
+# AttributesProp
+
+```ts
+type AttributesProp = Array<string | AttributeProps | Children>;
+```

package/docs/api/types/CSharpClassScope.md

@@ -0,0 +1,9 @@
+# CSharpClassScope
+
+## Members
+
+Extends [CSharpNamedTypeScope](../csharpnamedtypescope/)
+
+|            |                                                 |                                                                                                                   |
+| ---------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
+| parameters | [OutputSpace](../../../core/types/outputspace/) | For now, we stuff class parameters into the member scope. This is to ensure name conflicts are handled correctly. |

package/docs/api/types/CSharpElements.md

@@ -0,0 +1,5 @@
+# CSharpElements
+
+```ts
+type CSharpElements = "class" | "constant" | "variable" | "struct" | "enum" | "enum-member" | "function" | "interface" | "record" | "class-member-private" | "class-member-public" | "class-method" | "class-property" | "parameter" | "type-parameter" | "namespace";
+```

package/docs/api/types/CSharpFormatOptions.md

@@ -0,0 +1,5 @@
+# CSharpFormatOptions
+
+```ts
+CSharpFormatOptions: import("@alloy-js/core").ComponentDefinition<import("@alloy-js/core").ContextProviderProps<CSharpFormatOptions>>
+```

package/docs/api/types/CSharpLexicalScope.md

@@ -0,0 +1,10 @@
+# CSharpLexicalScope
+
+## Members
+
+Extends [CSharpScope](../csharpscope/)
+
+|                   |                                                 |   |
+| ----------------- | ----------------------------------------------- | - |
+| declarationSpaces | string\[]                                       |   |
+| localVariables    | [OutputSpace](../../../core/types/outputspace/) |   |

package/docs/api/types/CSharpMethodScope.md

@@ -0,0 +1,12 @@
+# CSharpMethodScope
+
+## Members
+
+Extends [CSharpLexicalScope](../csharplexicalscope/)
+
+|                   |                                                 |   |
+| ----------------- | ----------------------------------------------- | - |
+| declarationSpaces | string\[]                                       |   |
+| localVariables    | [OutputSpace](../../../core/types/outputspace/) |   |
+| parameters        | [OutputSpace](../../../core/types/outputspace/) |   |
+| typeParameters    | [OutputSpace](../../../core/types/outputspace/) |   |

package/docs/api/types/CSharpNamedTypeScope.md

@@ -0,0 +1,16 @@
+# CSharpNamedTypeScope
+
+This scope contains NamedTypeSymbols for types that are declared in containers like namespaces. This scope is a member scope which whose member symbol is a NamedTypeSymbol.
+
+## Members
+
+Extends [CSharpScope](../csharpscope/)
+
+|                    |                                                                                                                                      |                                                                                                                  |
+| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- |
+| constructor        | (ownerSymbol: NamedTypeSymbol, parentScope: CSharpNamedTypeScope \| CSharpSourceFileScope \| undefined, options: OutputScopeOptions) | Constructs a new instance of the [`CSharpNamedTypeScope`](CSharpNamedTypeScope.md) class                                                    |
+| declarationSpaces  | never\[]                                                                                                                             |                                                                                                                  |
+| enclosingNamespace | import(”../index.js”).[NamespaceSymbol](../namespacesymbol/) \| undefined                                                            |                                                                                                                  |
+| members            | import(“@alloy-js/core”).[OutputMemberSpace](../../../core/types/outputmemberspace/)                                                 |                                                                                                                  |
+| ownerSymbol        | [NamedTypeSymbol](../namedtypesymbol/)                                                                                               |                                                                                                                  |
+| typeParameters     | import(“@alloy-js/core”).[OutputMemberSpace](../../../core/types/outputmemberspace/)                                                 | For now, we stuff type parameters into the member scope. This is to ensure name conflicts are handled correctly. |

package/docs/api/types/CSharpNamespaceScope.md

@@ -0,0 +1,10 @@
+# CSharpNamespaceScope
+
+## Members
+
+Extends [CSharpNamedTypeScope](../csharpnamedtypescope/)
+
+|             |                                                                                                |                                                               |
+| ----------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
+| constructor | (namespaceSymbol: NamespaceSymbol, parentScope: CSharpNamespaceScope \| CSharpSourceFileScope) | Constructs a new instance of the [`CSharpNamespaceScope`](CSharpNamespaceScope.md) class |
+| ownerSymbol | [NamespaceSymbol](../namespacesymbol/)                                                         |                                                               |

package/docs/api/types/CSharpProjectSdk.md

@@ -0,0 +1,5 @@
+# CSharpProjectSdk
+
+```ts
+type CSharpProjectSdk = "Microsoft.NET.Sdk" | "Microsoft.NET.Sdk.Web" | "Microsoft.NET.Sdk.Worker" | "Microsoft.NET.Sdk.Razor" | "Microsoft.NET.Sdk.BlazorWebAssembly" | "Aspire.AppHost.Sdk" | "MSTest.Sdk";
+```

package/docs/api/types/CSharpScope.md

@@ -0,0 +1,12 @@
+# CSharpScope
+
+## Members
+
+Extends [OutputScope](../../../core/types/outputscope/)
+
+|                    |                                                                               |                                                      |
+| ------------------ | ----------------------------------------------------------------------------- | ---------------------------------------------------- |
+| constructor        | (name: string, parent: CSharpScope \| undefined, options: OutputScopeOptions) | Constructs a new instance of the [`CSharpScope`](CSharpScope.md) class |
+| debugInfo          | Record\<string, unknown>                                                      |                                                      |
+| enclosingNamespace | [NamespaceSymbol](../namespacesymbol/) \| undefined                           |                                                      |
+| ownerSymbol        | [CSharpSymbol](../csharpsymbol/) \| undefined                                 |                                                      |

package/docs/api/types/CSharpSourceFileScope.md

@@ -0,0 +1,13 @@
+# CSharpSourceFileScope
+
+## Members
+
+Extends [CSharpLexicalScope](../csharplexicalscope/)
+
+|                   |                                                                                         |                                                                |
+| ----------------- | --------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
+| constructor       | (name: string, parent: CSharpNamespaceScope, options: OutputScopeOptions)               | Constructs a new instance of the [`CSharpSourceFileScope`](CSharpSourceFileScope.md) class |
+| addUsing          | (using: NamespaceSymbol) => void                                                        |                                                                |
+| hasBlockNamespace | boolean                                                                                 |                                                                |
+| parent            | [CSharpNamespaceScope](../csharpnamespacescope/)                                        |                                                                |
+| usings            | import(“@vue/reactivity”).ShallowReactive\<Set<[NamespaceSymbol](../namespacesymbol/)>> |                                                                |

package/docs/api/types/CSharpSymbol.md

@@ -0,0 +1,30 @@
+# CSharpSymbol
+
+This is the base type for all symbols in C#.
+
+Many subtypes of this symbol exist for specific purposes. However, this symbol may be used in cases where a more specific symbol is not required.
+
+## Members
+
+Extends [OutputSymbol](../../../core/types/outputsymbol/)
+
+|                    |                                                                                                             |                                                                                                                                                                     |
+| ------------------ | ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| constructor        | (name: string \| Namekey, spaces: OutputSpace\[] \| OutputSpace \| undefined, options: CSharpSymbolOptions) | Constructs a new instance of the [`CSharpSymbol`](CSharpSymbol.md) class                                                                                                               |
+| accessibility      | [DeclaredAccessibility](../declaredaccessibility/) \| undefined                                             |                                                                                                                                                                     |
+| copy               | () => CSharpSymbol                                                                                          |                                                                                                                                                                     |
+| debugInfo          | Record\<string, unknown>                                                                                    |                                                                                                                                                                     |
+| enclosingNamespace | [NamespaceSymbol](../namespacesymbol/) \| undefined                                                         |                                                                                                                                                                     |
+| isAbstract         | boolean                                                                                                     | Whether this symbol is abstract.                                                                                                                                    |
+| isExtern           | boolean                                                                                                     | Whether this symbol is extern.                                                                                                                                      |
+| isNullable         | boolean                                                                                                     | Whether this symbol might contain null. True if this symbol has a `typeSymbol` and that symbol is nullable, or else when this symbol has the `nullable` option set. |
+| isOverride         | boolean                                                                                                     | Whether this symbol is override.                                                                                                                                    |
+| isReadOnly         | boolean                                                                                                     | Whether this symbol is readonly.                                                                                                                                    |
+| isSealed           | boolean                                                                                                     | Whether this symbol is sealed.                                                                                                                                      |
+| isStatic           | boolean                                                                                                     | Whether this symbol is static.                                                                                                                                      |
+| isVirtual          | boolean                                                                                                     | Whether this symbol is virtual.                                                                                                                                     |
+| symbolKind         | [CSharpSymbolKinds](../csharpsymbolkinds/)                                                                  |                                                                                                                                                                     |
+
+## Remarks
+
+This is roughly equivalent to the Roslyn ISymbol interface: <https://learn.microsoft.com/en-us/dotnet/api/microsoft.codeanalysis.isymbol?view=roslyn-dotnet-4.13.0>

package/docs/api/types/CSharpSymbolKinds.md

@@ -0,0 +1,5 @@
+# CSharpSymbolKinds
+
+```ts
+type CSharpSymbolKinds = "symbol" | "named-type" | "method" | "field" | "property" | "namespace" | "event";
+```

package/docs/api/types/CSharpSymbolOptions.md

@@ -0,0 +1,17 @@
+# CSharpSymbolOptions
+
+## Members
+
+Extends [OutputSymbolOptions](../../../core/types/outputsymboloptions/)
+
+|               |                                                             |                                                      |
+| ------------- | ----------------------------------------------------------- | ---------------------------------------------------- |
+| accessibility | optional [DeclaredAccessibility](../declaredaccessibility/) | The accessibility of the symbol.                     |
+| isAbstract    | optional boolean                                            |                                                      |
+| isExtern      | optional boolean                                            |                                                      |
+| isNullable    | optional boolean                                            | Whether the value held by this symbol could be null. |
+| isOverride    | optional boolean                                            |                                                      |
+| isReadOnly    | optional boolean                                            |                                                      |
+| isSealed      | optional boolean                                            |                                                      |
+| isStatic      | optional boolean                                            |                                                      |
+| isVirtual     | optional boolean                                            |                                                      |

package/docs/api/types/ClassDescriptor.md

@@ -0,0 +1,9 @@
+# ClassDescriptor
+
+## Members
+
+Extends [NamedTypeDescriptor](../namedtypedescriptor/)\<M>
+
+|      |         |   |
+| ---- | ------- | - |
+| kind | ”class” |   |

package/docs/api/types/ClassModifiers.md

@@ -0,0 +1,10 @@
+# ClassModifiers
+
+## Members
+
+|          |                  |   |
+| -------- | ---------------- | - |
+| abstract | optional boolean |   |
+| partial  | optional boolean |   |
+| sealed   | optional boolean |   |
+| static   | optional boolean |   |

package/docs/api/types/CreateMethodSymbolOptions.md

@@ -0,0 +1,9 @@
+# CreateMethodSymbolOptions
+
+## Members
+
+Extends [CSharpSymbolOptions](../csharpsymboloptions/)
+
+|            |                                         |   |
+| ---------- | --------------------------------------- | - |
+| methodKind | optional [MethodKinds](../methodkinds/) |   |

package/docs/api/types/CreateTypeParameterSymbolOptions.md

@@ -0,0 +1,9 @@
+# CreateTypeParameterSymbolOptions
+
+## Members
+
+Extends [CSharpSymbolOptions](../csharpsymboloptions/)
+
+|       |                                                                                                         |   |
+| ----- | ------------------------------------------------------------------------------------------------------- | - |
+| scope | optional [CSharpMethodScope](../csharpmethodscope/) \| [CSharpNamedTypeScope](../csharpnamedtypescope/) |   |

package/docs/api/types/DeclarationModifiers.md

@@ -0,0 +1,8 @@
+# DeclarationModifiers
+
+## Members
+
+Extends [AccessModifiers](../accessmodifiers/),[NonAccessModifiers](../nonaccessmodifiers/)
+
+|   |
+| - |

package/docs/api/types/DeclaredAccessibility.md

@@ -0,0 +1,5 @@
+# DeclaredAccessibility
+
+```ts
+type DeclaredAccessibility = "private" | "protected" | "internal" | "public";
+```

package/docs/api/types/Descriptor.md

@@ -0,0 +1,5 @@
+# Descriptor
+
+```ts
+type Descriptor = FieldDescriptor | MethodDescriptor | PropertyDescriptor | NamespaceDescriptor<any> | ClassDescriptor<any> | InterfaceDescriptor<any> | EnumDescriptor<any> | StructDescriptor<any> | RecordDescriptor<any> | GenericDescriptor;
+```

package/docs/api/types/DocCommentTagProps.md

@@ -0,0 +1,7 @@
+# DocCommentTagProps
+
+## Members
+
+|          |                                           |   |
+| -------- | ----------------------------------------- | - |
+| children | [Children](../../../core/types/children/) |   |

package/docs/api/types/EnumDescriptor.md

@@ -0,0 +1,9 @@
+# EnumDescriptor
+
+## Members
+
+Extends [NamedTypeDescriptor](../namedtypedescriptor/)\<M>
+
+|      |        |   |
+| ---- | ------ | - |
+| kind | ”enum” |   |

package/docs/api/types/FieldDescriptor.md

@@ -0,0 +1,9 @@
+# FieldDescriptor
+
+## Members
+
+Extends [MemberDescriptor](../memberdescriptor/)
+
+|      |         |   |
+| ---- | ------- | - |
+| kind | ”field” |   |

package/docs/api/types/FieldModifiers.md

@@ -0,0 +1,12 @@
+# FieldModifiers
+
+Field modifiers.
+
+## Members
+
+|          |                  |   |
+| -------- | ---------------- | - |
+| new      | optional boolean |   |
+| readonly | optional boolean |   |
+| static   | optional boolean |   |
+| volatile | optional boolean |   |

package/docs/api/types/GenericDescriptor.md

@@ -0,0 +1,7 @@
+# GenericDescriptor
+
+## Members
+
+|      |           |   |
+| ---- | --------- | - |
+| kind | ”generic” |   |

package/docs/api/types/InterfaceDescriptor.md

@@ -0,0 +1,9 @@
+# InterfaceDescriptor
+
+## Members
+
+Extends [NamedTypeDescriptor](../namedtypedescriptor/)\<M>
+
+|      |             |   |
+| ---- | ----------- | - |
+| kind | ”interface” |   |

package/docs/api/types/InterfaceMethodModifiers.md

@@ -0,0 +1,9 @@
+# InterfaceMethodModifiers
+
+Method modifiers. Can only be one.
+
+## Members
+
+|     |                  |   |
+| --- | ---------------- | - |
+| new | optional boolean |   |

package/docs/api/types/InterfaceModifiers.md

@@ -0,0 +1,7 @@
+# InterfaceModifiers
+
+## Members
+
+|         |                  |   |
+| ------- | ---------------- | - |
+| partial | optional boolean |   |