@fable-org/fable-library-js 1.5.0 → 1.7.0

package/Async.d.ts

@@ -1,32 +1,27 @@
 import { Continuation, Continuations } from "./AsyncBuilder.js";
-import { CancellationToken } from "./AsyncBuilder.js";
-import { IAsync } from "./AsyncBuilder.js";
-import { IAsyncContext } from "./AsyncBuilder.js";
+import { Async, IAsyncContext, CancellationToken } from "./AsyncBuilder.js";
 import { FSharpChoice$2_$union } from "./Choice.js";
-export declare class Async<_T> {
-}
-export declare function makeAsync<T>(body: IAsync<T>): IAsync<T>;
-export declare function invoke<T>(computation: IAsync<T>, ctx: IAsyncContext<T>): void;
-export declare function callThenInvoke<T, U>(ctx: IAsyncContext<T>, result1: U, part2: (x: U) => IAsync<T>): void;
-export declare function bind<T, U>(ctx: IAsyncContext<T>, part1: IAsync<U>, part2: (x: U) => IAsync<T>): void;
+export declare function makeAsync<T>(body: Async<T>): Async<T>;
+export declare function invoke<T>(computation: Async<T>, ctx: IAsyncContext<T>): void;
+export declare function callThenInvoke<T, U>(ctx: IAsyncContext<T>, result1: U, part2: (x: U) => Async<T>): void;
+export declare function bind<T, U>(ctx: IAsyncContext<T>, part1: Async<U>, part2: (x: U) => Async<T>): void;
 export declare function createCancellationToken(arg?: boolean | number): CancellationToken;
 export declare function cancel(token: CancellationToken): void;
 export declare function cancelAfter(token: CancellationToken, ms: number): void;
 export declare function isCancellationRequested(token: CancellationToken): boolean;
 export declare function throwIfCancellationRequested(token: CancellationToken): void;
-export declare function startChild<T>(computation: IAsync<T>, ms?: number): IAsync<IAsync<T>>;
+export declare function startChild<T>(computation: Async<T>, ms?: number): Async<Async<T>>;
 export declare function awaitPromise<T>(p: Promise<T>): (ctx: IAsyncContext<T>) => void;
 export declare function cancellationToken(): (ctx: IAsyncContext<CancellationToken>) => void;
 export declare const defaultCancellationToken: CancellationToken;
-export declare function catchAsync<T>(work: IAsync<T>): (ctx: IAsyncContext<FSharpChoice$2_$union<T, Error>>) => void;
+export declare function catchAsync<T>(work: Async<T>): (ctx: IAsyncContext<FSharpChoice$2_$union<T, Error>>) => void;
 export declare function fromContinuations<T>(f: (conts: Continuations<T>) => void): (ctx: IAsyncContext<T>) => void;
-export declare function ignore<T>(computation: IAsync<T>): (ctx: IAsyncContext<undefined>) => void;
-export declare function parallel<T>(computations: Iterable<IAsync<T>>): (ctx: IAsyncContext<Awaited<T>[]>) => void;
-export declare function sequential<T>(computations: Iterable<IAsync<T>>): (ctx: IAsyncContext<T[]>) => void;
+export declare function ignore<T>(computation: Async<T>): (ctx: IAsyncContext<undefined>) => void;
+export declare function parallel<T>(computations: Iterable<Async<T>>): (ctx: IAsyncContext<Awaited<T>[]>) => void;
+export declare function sequential<T>(computations: Iterable<Async<T>>): (ctx: IAsyncContext<T[]>) => void;
 export declare function sleep(millisecondsDueTime: number): (ctx: IAsyncContext<void>) => void;
 export declare function runSynchronously(): never;
-export declare function start<T>(computation: IAsync<T>, cancellationToken?: CancellationToken): void;
-export declare function startImmediate<T>(computation: IAsync<T>, cancellationToken?: CancellationToken): void;
-export declare function startWithContinuations<T>(computation: IAsync<T>, continuation?: Continuation<T> | CancellationToken, exceptionContinuation?: Continuation<any>, cancellationContinuation?: Continuation<any>, cancelToken?: CancellationToken): void;
-export declare function startAsPromise<T>(computation: IAsync<T>, cancellationToken?: CancellationToken): Promise<T>;
-export default Async;
+export declare function start<T>(computation: Async<T>, cancellationToken?: CancellationToken): void;
+export declare function startImmediate<T>(computation: Async<T>, cancellationToken?: CancellationToken): void;
+export declare function startWithContinuations<T>(computation: Async<T>, continuation?: Continuation<T> | CancellationToken, exceptionContinuation?: Continuation<any>, cancellationContinuation?: Continuation<any>, cancelToken?: CancellationToken): void;
+export declare function startAsPromise<T>(computation: Async<T>, cancellationToken?: CancellationToken): Promise<T>;

package/Async.js

@@ -1,13 +1,8 @@
 import { OperationCanceledError, Trampoline } from "./AsyncBuilder.js";
 import { CancellationToken } from "./AsyncBuilder.js";
-import { protectedCont } from "./AsyncBuilder.js";
-import { protectedBind } from "./AsyncBuilder.js";
-import { protectedReturn } from "./AsyncBuilder.js";
+import { protectedCont, protectedBind, protectedReturn } from "./AsyncBuilder.js";
 import { Choice_makeChoice1Of2, Choice_makeChoice2Of2 } from "./Choice.js";
 import { TimeoutException } from "./SystemException.js";
-// Implemented just for type references
-export class Async {
-}
 function emptyContinuation(_x) {
     // NOP
 }
@@ -155,4 +150,3 @@ export function startWithContinuations(computation, continuation, exceptionConti
 export function startAsPromise(computation, cancellationToken) {
     return new Promise((resolve, reject) => startWithContinuations(computation, resolve, reject, reject, cancellationToken ? cancellationToken : defaultCancellationToken));
 }
-export default Async;

package/AsyncBuilder.d.ts

@@ -39,21 +39,21 @@ export interface IAsyncContext<T> {
     cancelToken: CancellationToken;
     trampoline: Trampoline;
 }
-export type IAsync<T> = (x: IAsyncContext<T>) => void;
-export declare function protectedCont<T>(f: IAsync<T>): (ctx: IAsyncContext<T>) => void;
-export declare function protectedBind<T, U>(computation: IAsync<T>, binder: (x: T) => IAsync<U>): (ctx: IAsyncContext<U>) => void;
+export type Async<T> = (x: IAsyncContext<T>) => void;
+export declare function protectedCont<T>(f: Async<T>): (ctx: IAsyncContext<T>) => void;
+export declare function protectedBind<T, U>(computation: Async<T>, binder: (x: T) => Async<U>): (ctx: IAsyncContext<U>) => void;
 export declare function protectedReturn<T>(value: T): (ctx: IAsyncContext<T>) => void;
 export declare class AsyncBuilder {
-    Bind<T, U>(computation: IAsync<T>, binder: (x: T) => IAsync<U>): (ctx: IAsyncContext<U>) => void;
-    Combine<T>(computation1: IAsync<void>, computation2: IAsync<T>): (ctx: IAsyncContext<T>) => void;
-    Delay<T>(generator: () => IAsync<T>): (ctx: IAsyncContext<T>) => void;
-    For<T>(sequence: Iterable<T>, body: (x: T) => IAsync<void>): IAsync<void>;
-    Return<T>(value?: T): (ctx: IAsyncContext<T | undefined>) => void;
-    ReturnFrom<T>(computation: IAsync<T>): IAsync<T>;
-    TryFinally<T>(computation: IAsync<T>, compensation: () => void): (ctx: IAsyncContext<T>) => void;
-    TryWith<T>(computation: IAsync<T>, catchHandler: (e: any) => IAsync<T>): (ctx: IAsyncContext<T>) => void;
-    Using<T extends IDisposable, U>(resource: T, binder: (x: T) => IAsync<U>): (ctx: IAsyncContext<U>) => void;
-    While(guard: () => boolean, computation: IAsync<void>): IAsync<void>;
+    Bind<T, U>(computation: Async<T>, binder: (x: T) => Async<U>): (ctx: IAsyncContext<U>) => void;
+    Combine<T>(computation1: Async<void>, computation2: Async<T>): (ctx: IAsyncContext<T>) => void;
+    Delay<T>(generator: () => Async<T>): (ctx: IAsyncContext<T>) => void;
+    For<T>(sequence: Iterable<T>, body: (x: T) => Async<void>): Async<void>;
+    Return<T>(value: T): (ctx: IAsyncContext<T>) => void;
+    ReturnFrom<T>(computation: Async<T>): Async<T>;
+    TryFinally<T>(computation: Async<T>, compensation: () => void): (ctx: IAsyncContext<T>) => void;
+    TryWith<T>(computation: Async<T>, catchHandler: (e: any) => Async<T>): (ctx: IAsyncContext<T>) => void;
+    Using<T extends IDisposable, U>(resource: T, binder: (x: T) => Async<U>): (ctx: IAsyncContext<U>) => void;
+    While(guard: () => boolean, computation: Async<void>): Async<void>;
     Zero(): (ctx: IAsyncContext<void>) => void;
 }
 export declare const singleton: AsyncBuilder;

package/CHANGELOG.md

@@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 1.7.0 - 2024-11-19
+
+### Fixed
+
+* [JS/TS] Added missing IReadOnlyCollection helpers (#3953)
+
+## 1.6.0 - 2024-10-02
+
+### Removed
+
+* Remove `Async` (from `Async.ts`) class (by @MangelMaxime)
+
+### Changed
+
+* Renamed `IAsync` to `Async` in `AsyncBuilder.ts` (#3906) (by @ncave)
+
 ## 1.5.0 - 2024-09-19
 
 ### Added

package/CollectionUtil.d.ts

@@ -0,0 +1,7 @@
+export declare function count<T>(col: Iterable<T>): number;
+export declare function isReadOnly<T>(col: Iterable<T>): boolean;
+export declare function copyTo<T>(col: Iterable<T>, array: T[], arrayIndex: number): void;
+export declare function contains<T>(col: Iterable<T>, item: T): boolean;
+export declare function add<T>(col: Iterable<T>, item: T): void;
+export declare function remove<T>(col: Iterable<T>, item: T): boolean;
+export declare function clear<T>(col: Iterable<T>): void;

package/CollectionUtil.js

@@ -0,0 +1,182 @@
+import { equals, isArrayLike } from "./Util.js";
+export function count(col) {
+    if (typeof col["System.Collections.Generic.ICollection`1.get_Count"] === "function") {
+        return col["System.Collections.Generic.ICollection`1.get_Count"](); // collection
+    }
+    else {
+        if (typeof col["System.Collections.Generic.IReadOnlyCollection`1.get_Count"] === "function") {
+            return col["System.Collections.Generic.IReadOnlyCollection`1.get_Count"](); // collection
+        }
+        else {
+            if (isArrayLike(col)) {
+                return col.length; // array, resize array
+            }
+            else {
+                if (typeof col.size === "number") {
+                    return col.size; // map, set
+                }
+                else {
+                    let count = 0;
+                    for (const _ of col) {
+                        count++;
+                    }
+                    return count; // other collections
+                }
+            }
+        }
+    }
+}
+export function isReadOnly(col) {
+    if (typeof col["System.Collections.Generic.ICollection`1.get_IsReadOnly"] === "function") {
+        return col["System.Collections.Generic.ICollection`1.get_IsReadOnly"](); // collection
+    }
+    else {
+        if (isArrayLike(col)) {
+            return ArrayBuffer.isView(col); // true for typed arrays, false for other arrays
+        }
+        else {
+            if (typeof col.size === "number") {
+                return false; // map, set
+            }
+            else {
+                return true; // other collections
+            }
+        }
+    }
+}
+export function copyTo(col, array, arrayIndex) {
+    if (typeof col["System.Collections.Generic.ICollection`1.CopyToZ3B4C077E"] === "function") {
+        col["System.Collections.Generic.ICollection`1.CopyToZ3B4C077E"](array, arrayIndex); // collection
+    }
+    else {
+        let i = arrayIndex;
+        for (const v of col) {
+            array[i] = v;
+            i++;
+        }
+    }
+}
+export function contains(col, item) {
+    if (typeof col["System.Collections.Generic.ICollection`1.Contains2B595"] === "function") {
+        return col["System.Collections.Generic.ICollection`1.Contains2B595"](item); // collection
+    }
+    else {
+        if (isArrayLike(col)) {
+            let i = col.findIndex(x => equals(x, item)); // array, resize array
+            return i >= 0;
+        }
+        else {
+            if (typeof col.has === "function") {
+                if (typeof col.set === "function" && isArrayLike(item)) {
+                    return col.has(item[0]) && equals(col.get(item[0]), item[1]); // map
+                }
+                else {
+                    return col.has(item); // set
+                }
+            }
+            else {
+                return false; // other collections
+            }
+        }
+    }
+}
+export function add(col, item) {
+    if (typeof col["System.Collections.Generic.ICollection`1.Add2B595"] === "function") {
+        return col["System.Collections.Generic.ICollection`1.Add2B595"](item); // collection
+    }
+    else {
+        if (isArrayLike(col)) {
+            if (ArrayBuffer.isView(col)) {
+                // TODO: throw for typed arrays?
+            }
+            else {
+                col.push(item); // array, resize array
+            }
+        }
+        else {
+            if (typeof col.add === "function") {
+                return col.add(item); // set
+            }
+            else {
+                if (typeof col.has === "function"
+                    && typeof col.set === "function"
+                    && isArrayLike(item)) {
+                    if (col.has(item[0]) === false) {
+                        col.set(item[0], item[1]); // map
+                    }
+                    else {
+                        throw new Error("An item with the same key has already been added. Key: " + item[0]);
+                    }
+                }
+                else {
+                    // TODO: throw for other collections?
+                }
+            }
+        }
+    }
+}
+export function remove(col, item) {
+    if (typeof col["System.Collections.Generic.ICollection`1.Remove2B595"] === "function") {
+        return col["System.Collections.Generic.ICollection`1.Remove2B595"](item); // collection
+    }
+    else {
+        if (isArrayLike(col)) {
+            if (ArrayBuffer.isView(col)) {
+                // TODO: throw for typed arrays
+                return false;
+            }
+            else {
+                let i = col.findIndex(x => equals(x, item));
+                if (i >= 0) {
+                    col.splice(i, 1); // array, resize array
+                    return true;
+                }
+                else {
+                    return false;
+                }
+            }
+        }
+        else {
+            if (typeof col.delete === "function") {
+                if (typeof col.set === "function" && isArrayLike(item)) {
+                    if (col.has(item[0]) && equals(col.get(item[0]), item[1])) {
+                        return col.delete(item[0]); // map
+                    }
+                    else {
+                        return false;
+                    }
+                }
+                else {
+                    return col.delete(item); // set
+                }
+            }
+            else {
+                // TODO: throw for other collections?
+                return false; // other collections
+            }
+        }
+    }
+}
+export function clear(col) {
+    if (typeof col["System.Collections.Generic.ICollection`1.Clear"] === "function") {
+        return col["System.Collections.Generic.ICollection`1.Clear"](); // collection
+    }
+    else {
+        if (isArrayLike(col)) {
+            if (ArrayBuffer.isView(col)) {
+                // TODO: throw for typed arrays?
+            }
+            else {
+                col.splice(0); // array, resize array
+            }
+        }
+        else {
+            if (typeof col.clear === "function") {
+                col.clear(); // map, set
+            }
+            else {
+                // TODO: throw for other collections?
+            }
+        }
+    }
+}

package/MailboxProcessor.d.ts

@@ -1,4 +1,4 @@
-import { IAsync } from "./AsyncBuilder.js";
+import { Async } from "./AsyncBuilder.js";
 import { Continuation } from "./AsyncBuilder.js";
 import { CancellationToken } from "./AsyncBuilder.js";
 declare class MailboxQueue<Msg> {
@@ -6,7 +6,7 @@ declare class MailboxQueue<Msg> {
     add(message: Msg): void;
     tryGet(): Msg | undefined;
 }
-export type MailboxBody<Msg> = (m: MailboxProcessor<Msg>) => IAsync<void>;
+export type MailboxBody<Msg> = (m: MailboxProcessor<Msg>) => Async<void>;
 export interface AsyncReplyChannel<Reply> {
     reply: (r: Reply) => void;
 }

package/String.d.ts

@@ -1,8 +1,16 @@
+declare const enum StringComparison {
+    CurrentCulture = 0,
+    CurrentCultureIgnoreCase = 1,
+    InvariantCulture = 2,
+    InvariantCultureIgnoreCase = 3,
+    Ordinal = 4,
+    OrdinalIgnoreCase = 5
+}
 export declare function compare(...args: any[]): number;
 export declare function compareOrdinal(x: string, y: string): number;
 export declare function compareTo(x: string, y: string): number;
-export declare function startsWith(str: string, pattern: string, ic: number): boolean;
-export declare function endsWith(str: string, pattern: string, ic: number): boolean;
+export declare function startsWith(str: string, pattern: string, ic: boolean | StringComparison): boolean;
+export declare function endsWith(str: string, pattern: string, ic: boolean | StringComparison): boolean;
 export declare function indexOfAny(str: string, anyOf: string[], ...args: number[]): number;
 export type IPrintfFormatContinuation = (f: (x: string) => any) => any;
 export interface IPrintfFormat {

package/package.json

@@ -3,7 +3,7 @@
   "private": false,
   "type": "module",
   "name": "@fable-org/fable-library-js",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "description": "Core library used by F# projects compiled with fable.io",
   "author": "Fable Contributors",
   "license": "MIT",