Skip to content

Commit

Permalink
Update generated documentation for version 1.4.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Thorium committed Oct 9, 2024
1 parent 58986a3 commit 8ccd52a
Show file tree
Hide file tree
Showing 35 changed files with 114 additions and 82 deletions.
28 changes: 14 additions & 14 deletions core/async.html
Original file line number Diff line number Diff line change
Expand Up @@ -412,35 +412,35 @@ <h3><a name="Why-Not-to-Use-Async" class="anchor" href="#Why-Not-to-Use-Async">W
<div class="fsdocs-tip" id="fs23">val id: Guid</div>
<div class="fsdocs-tip" id="fs24">Multiple items<br />[&lt;Struct&gt;]
type Guid =
new: b: byte array -&gt; unit + 5 overloads
new: b: byte array -&gt; unit + 6 overloads
member CompareTo: value: Guid -&gt; int + 1 overload
member Equals: g: Guid -&gt; bool + 1 overload
member GetHashCode: unit -&gt; int
member ToByteArray: unit -&gt; byte array
member ToByteArray: unit -&gt; byte array + 1 overload
member ToString: unit -&gt; string + 2 overloads
member TryFormat: destination: Span&lt;char&gt; * charsWritten: byref&lt;int&gt; * ?format: ReadOnlySpan&lt;char&gt; -&gt; bool
member TryWriteBytes: destination: Span&lt;byte&gt; -&gt; bool
static member (&lt;&gt;) : a: Guid * b: Guid -&gt; bool
static member (=) : a: Guid * b: Guid -&gt; bool
...<br /><em>&lt;summary&gt;Represents a globally unique identifier (GUID).&lt;/summary&gt;</em><br /><br />--------------------<br />Guid ()<br />Guid(b: byte array) : Guid<br />Guid(b: ReadOnlySpan&lt;byte&gt;) : Guid<br />Guid(g: string) : Guid<br />Guid(a: int, b: int16, c: int16, d: byte array) : Guid<br />Guid(a: int, b: int16, c: int16, d: byte, e: byte, f: byte, g: byte, h: byte, i: byte, j: byte, k: byte) : Guid<br />Guid(a: uint32, b: uint16, c: uint16, d: byte, e: byte, f: byte, g: byte, h: byte, i: byte, j: byte, k: byte) : Guid</div>
member TryFormat: destination: Span&lt;char&gt; * charsWritten: byref&lt;int&gt; * ?format: ReadOnlySpan&lt;char&gt; -&gt; bool + 1 overload
member TryWriteBytes: destination: Span&lt;byte&gt; -&gt; bool + 1 overload
static member (&lt;) : left: Guid * right: Guid -&gt; bool
static member (&lt;=) : left: Guid * right: Guid -&gt; bool
...<br /><em>&lt;summary&gt;Represents a globally unique identifier (GUID).&lt;/summary&gt;</em><br /><br />--------------------<br />Guid ()<br />Guid(b: byte array) : Guid<br />Guid(b: ReadOnlySpan&lt;byte&gt;) : Guid<br />Guid(g: string) : Guid<br />Guid(b: ReadOnlySpan&lt;byte&gt;, bigEndian: bool) : Guid<br />Guid(a: int, b: int16, c: int16, d: byte array) : Guid<br />Guid(a: int, b: int16, c: int16, d: byte, e: byte, f: byte, g: byte, h: byte, i: byte, j: byte, k: byte) : Guid<br />Guid(a: uint32, b: uint16, c: uint16, d: byte, e: byte, f: byte, g: byte, h: byte, i: byte, j: byte, k: byte) : Guid</div>
<div class="fsdocs-tip" id="fs25">Multiple items<br />type Task =
interface IAsyncResult
interface IDisposable
new: action: Action -&gt; unit + 7 overloads
member ConfigureAwait: continueOnCapturedContext: bool -&gt; ConfiguredTaskAwaitable
member ConfigureAwait: continueOnCapturedContext: bool -&gt; ConfiguredTaskAwaitable + 1 overload
member ContinueWith: continuationAction: Action&lt;Task,obj&gt; * state: obj -&gt; Task + 19 overloads
member Dispose: unit -&gt; unit
member GetAwaiter: unit -&gt; TaskAwaiter
member RunSynchronously: unit -&gt; unit + 1 overload
member Start: unit -&gt; unit + 1 overload
member Wait: unit -&gt; unit + 4 overloads
member Wait: unit -&gt; unit + 5 overloads
...<br /><em>&lt;summary&gt;Represents an asynchronous operation.&lt;/summary&gt;</em><br /><br />--------------------<br />type Task&lt;&#39;TResult&gt; =
inherit Task
new: ``function`` : Func&lt;obj,&#39;TResult&gt; * state: obj -&gt; unit + 7 overloads
member ConfigureAwait: continueOnCapturedContext: bool -&gt; ConfiguredTaskAwaitable&lt;&#39;TResult&gt;
member ConfigureAwait: continueOnCapturedContext: bool -&gt; ConfiguredTaskAwaitable&lt;&#39;TResult&gt; + 1 overload
member ContinueWith: continuationAction: Action&lt;Task&lt;&#39;TResult&gt;,obj&gt; * state: obj -&gt; Task + 19 overloads
member GetAwaiter: unit -&gt; TaskAwaiter&lt;&#39;TResult&gt;
member WaitAsync: timeout: TimeSpan -&gt; Task&lt;&#39;TResult&gt; + 2 overloads
member WaitAsync: cancellationToken: CancellationToken -&gt; Task&lt;&#39;TResult&gt; + 4 overloads
member Result: &#39;TResult
static member Factory: TaskFactory&lt;&#39;TResult&gt;<br /><em>&lt;summary&gt;Represents an asynchronous operation that can return a value.&lt;/summary&gt;<br />&lt;typeparam name=&quot;TResult&quot;&gt;The type of the result produced by this &lt;see cref=&quot;T:System.Threading.Tasks.Task`1&quot; /&gt;.&lt;/typeparam&gt;</em><br /><br />--------------------<br />Task(action: Action) : Task<br />Task(action: Action, cancellationToken: Threading.CancellationToken) : Task<br />Task(action: Action, creationOptions: TaskCreationOptions) : Task<br />Task(action: Action&lt;obj&gt;, state: obj) : Task<br />Task(action: Action, cancellationToken: Threading.CancellationToken, creationOptions: TaskCreationOptions) : Task<br />Task(action: Action&lt;obj&gt;, state: obj, cancellationToken: Threading.CancellationToken) : Task<br />Task(action: Action&lt;obj&gt;, state: obj, creationOptions: TaskCreationOptions) : Task<br />Task(action: Action&lt;obj&gt;, state: obj, cancellationToken: Threading.CancellationToken, creationOptions: TaskCreationOptions) : Task<br /><br />--------------------<br />Task(``function`` : Func&lt;&#39;TResult&gt;) : Task&lt;&#39;TResult&gt;<br />Task(``function`` : Func&lt;obj,&#39;TResult&gt;, state: obj) : Task&lt;&#39;TResult&gt;<br />Task(``function`` : Func&lt;&#39;TResult&gt;, cancellationToken: Threading.CancellationToken) : Task&lt;&#39;TResult&gt;<br />Task(``function`` : Func&lt;&#39;TResult&gt;, creationOptions: TaskCreationOptions) : Task&lt;&#39;TResult&gt;<br />Task(``function`` : Func&lt;obj,&#39;TResult&gt;, state: obj, cancellationToken: Threading.CancellationToken) : Task&lt;&#39;TResult&gt;<br />Task(``function`` : Func&lt;obj,&#39;TResult&gt;, state: obj, creationOptions: TaskCreationOptions) : Task&lt;&#39;TResult&gt;<br />Task(``function`` : Func&lt;&#39;TResult&gt;, cancellationToken: Threading.CancellationToken, creationOptions: TaskCreationOptions) : Task&lt;&#39;TResult&gt;<br />Task(``function`` : Func&lt;obj,&#39;TResult&gt;, state: obj, cancellationToken: Threading.CancellationToken, creationOptions: TaskCreationOptions) : Task&lt;&#39;TResult&gt;</div>
<div class="fsdocs-tip" id="fs26">val async: AsyncBuilder</div>
Expand Down Expand Up @@ -483,17 +483,17 @@ <h3><a name="Why-Not-to-Use-Async" class="anchor" href="#Why-Not-to-Use-Async">W
<div class="fsdocs-tip" id="fs44">val entity: obj</div>
<div class="fsdocs-tip" id="fs45">Multiple items<br />[&lt;Struct&gt;]
type DateTime =
new: year: int * month: int * day: int -&gt; unit + 10 overloads
new: year: int * month: int * day: int -&gt; unit + 16 overloads
member Add: value: TimeSpan -&gt; DateTime
member AddDays: value: float -&gt; DateTime
member AddHours: value: float -&gt; DateTime
member AddMicroseconds: value: float -&gt; DateTime
member AddMilliseconds: value: float -&gt; DateTime
member AddMinutes: value: float -&gt; DateTime
member AddMonths: months: int -&gt; DateTime
member AddSeconds: value: float -&gt; DateTime
member AddTicks: value: int64 -&gt; DateTime
member AddYears: value: int -&gt; DateTime
...<br /><em>&lt;summary&gt;Represents an instant in time, typically expressed as a date and time of day.&lt;/summary&gt;</em><br /><br />--------------------<br />DateTime ()<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(ticks: int64) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(ticks: int64, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, calendar: Globalization.Calendar) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, calendar: Globalization.Calendar) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em></div>
...<br /><em>&lt;summary&gt;Represents an instant in time, typically expressed as a date and time of day.&lt;/summary&gt;</em><br /><br />--------------------<br />DateTime ()<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(ticks: int64) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(ticks: int64, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(date: DateOnly, time: TimeOnly) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(date: DateOnly, time: TimeOnly, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, calendar: Globalization.Calendar) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, calendar: Globalization.Calendar) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em></div>
<div class="fsdocs-tip" id="fs46">property DateTime.UtcNow: DateTime with get<br /><em>&lt;summary&gt;Gets a &lt;see cref=&quot;T:System.DateTime&quot; /&gt; object that is set to the current date and time on this computer, expressed as the Coordinated Universal Time (UTC).&lt;/summary&gt;<br />&lt;returns&gt;An object whose value is the current UTC date and time.&lt;/returns&gt;</em></div>
<div class="fsdocs-tip" id="fs47">val box: value: &#39;T -&gt; obj</div>
<div class="fsdocs-tip" id="fs48">SqlDataProvider&lt;...&gt;.dataContext.SubmitUpdatesAsync() : Task<br /><em>&lt;summary&gt;Save changes to data-source. May throws errors: Use Async.Catch and to deal with non-saved items use GetUpdates() and ClearUpdates().&lt;/summary&gt;</em></div>
Expand Down
11 changes: 6 additions & 5 deletions core/crud.html
Original file line number Diff line number Diff line change
Expand Up @@ -535,17 +535,17 @@ <h3><a name="What-to-do-if-your-creation-fails-systematically-every-time" class=
<div class="fsdocs-tip" id="fs29">val now: DateTime</div>
<div class="fsdocs-tip" id="fs30">Multiple items<br />[&lt;Struct&gt;]
type DateTime =
new: year: int * month: int * day: int -&gt; unit + 10 overloads
new: year: int * month: int * day: int -&gt; unit + 16 overloads
member Add: value: TimeSpan -&gt; DateTime
member AddDays: value: float -&gt; DateTime
member AddHours: value: float -&gt; DateTime
member AddMicroseconds: value: float -&gt; DateTime
member AddMilliseconds: value: float -&gt; DateTime
member AddMinutes: value: float -&gt; DateTime
member AddMonths: months: int -&gt; DateTime
member AddSeconds: value: float -&gt; DateTime
member AddTicks: value: int64 -&gt; DateTime
member AddYears: value: int -&gt; DateTime
...<br /><em>&lt;summary&gt;Represents an instant in time, typically expressed as a date and time of day.&lt;/summary&gt;</em><br /><br />--------------------<br />DateTime ()<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(ticks: int64) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(ticks: int64, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, calendar: Globalization.Calendar) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, calendar: Globalization.Calendar) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, millisecond: int, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em></div>
...<br /><em>&lt;summary&gt;Represents an instant in time, typically expressed as a date and time of day.&lt;/summary&gt;</em><br /><br />--------------------<br />DateTime ()<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(ticks: int64) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(ticks: int64, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(date: DateOnly, time: TimeOnly) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(date: DateOnly, time: TimeOnly, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, calendar: Globalization.Calendar) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, kind: DateTimeKind) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em><br />DateTime(year: int, month: int, day: int, hour: int, minute: int, second: int, calendar: Globalization.Calendar) : DateTime<br />&#160;&#160;&#160;<em>(+0 other overloads)</em></div>
<div class="fsdocs-tip" id="fs31">property DateTime.Now: DateTime with get<br /><em>&lt;summary&gt;Gets a &lt;see cref=&quot;T:System.DateTime&quot; /&gt; object that is set to the current date and time on this computer, expressed as the local time.&lt;/summary&gt;<br />&lt;returns&gt;An object whose value is the current local date and time.&lt;/returns&gt;</em></div>
<div class="fsdocs-tip" id="fs32">val row: SqlDataProvider&lt;...&gt;.dataContext.main.OrdersEntity</div>
<div class="fsdocs-tip" id="fs33">SqlDataProvider&lt;...&gt;.dataContext.mainSchema.main.Orders.Create() : SqlDataProvider&lt;...&gt;.dataContext.main.OrdersEntity<br />SqlDataProvider&lt;...&gt;.dataContext.mainSchema.main.Orders.Create(data: Collections.Generic.IEnumerable&lt;string * obj&gt;) : SqlDataProvider&lt;...&gt;.dataContext.main.OrdersEntity<br /><em>&lt;summary&gt;Item array of database columns:
Expand Down Expand Up @@ -649,7 +649,8 @@ <h3><a name="What-to-do-if-your-creation-fails-systematically-every-time" class=
type OnConflict =
| Throw
| Update
| DoNothing</div>
| DoNothing
member Equals: OnConflict * IEqualityComparer -&gt; bool</div>
<div class="fsdocs-tip" id="fs94">union case Common.OnConflict.Update: Common.OnConflict<br /><em>&lt;summary&gt;
If the primary key already exists, updates the existing row&#39;s columns to match the new entity.
Currently supported only on PostgreSQL 9.5+
Expand Down Expand Up @@ -679,7 +680,7 @@ <h3><a name="What-to-do-if-your-creation-fails-systematically-every-time" class=
<div class="fsdocs-tip" id="fs106">union case CanonicalOp.Replace: SqlItemOrColumn * SqlItemOrColumn -&gt; CanonicalOp</div>
<div class="fsdocs-tip" id="fs107">val box: value: &#39;T -&gt; obj</div>
<div class="fsdocs-tip" id="fs108">val bdate: DateTime</div>
<div class="fsdocs-tip" id="fs109">DateTime.Parse(s: string) : DateTime<br />DateTime.Parse(s: string, provider: IFormatProvider) : DateTime<br />DateTime.Parse(s: string, provider: IFormatProvider, styles: Globalization.DateTimeStyles) : DateTime<br />DateTime.Parse(s: ReadOnlySpan&lt;char&gt;, ?provider: IFormatProvider, ?styles: Globalization.DateTimeStyles) : DateTime</div>
<div class="fsdocs-tip" id="fs109">DateTime.Parse(s: string) : DateTime<br />DateTime.Parse(s: string, provider: IFormatProvider) : DateTime<br />DateTime.Parse(s: ReadOnlySpan&lt;char&gt;, provider: IFormatProvider) : DateTime<br />DateTime.Parse(s: string, provider: IFormatProvider, styles: Globalization.DateTimeStyles) : DateTime<br />DateTime.Parse(s: ReadOnlySpan&lt;char&gt;, ?provider: IFormatProvider, ?styles: Globalization.DateTimeStyles) : DateTime</div>
<div class="fsdocs-tip" id="fs110">DateTime.AddYears(value: int) : DateTime</div>
<div class="fsdocs-tip" id="fs111">property DateTime.UtcNow: DateTime with get<br /><em>&lt;summary&gt;Gets a &lt;see cref=&quot;T:System.DateTime&quot; /&gt; object that is set to the current date and time on this computer, expressed as the Coordinated Universal Time (UTC).&lt;/summary&gt;<br />&lt;returns&gt;An object whose value is the current UTC date and time.&lt;/returns&gt;</em></div>
<div class="fsdocs-tip" id="fs112">val failwith: message: string -&gt; &#39;T</div>
Expand Down
Loading

0 comments on commit 8ccd52a

Please sign in to comment.