@xylabs/promise 4.13.15 → 4.13.17

package/README.md

@@ -1,63 +1,54 @@
-[![logo][]](https://xylabs.com)
-
 # @xylabs/promise
 
+[![logo][]](https://xylabs.com)
+
+[![main-build][]][main-build-link]
 [![npm-badge][]][npm-link]
 [![npm-downloads-badge][]][npm-link]
 [![jsdelivr-badge][]][jsdelivr-link]
 [![npm-license-badge][]](LICENSE)
+[![codacy-badge][]][codacy-link]
+[![codeclimate-badge][]][codeclimate-link]
+[![snyk-badge][]][snyk-link]
 [![socket-badge][]][socket-link]
 
-> XY Labs generalized Javascript library 
-
-## Table of Contents
-
--   [Description](#description)
--   [Install](#install)
--   [Maintainers](#maintainers)
--   [License](#license)
--   [Credits](#credits)
-
-## Description
+Version: 4.13.15
 
-Common Javascript code that is used throughout XYO projects that use React.
+Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
-## Install
-
-Using npm:
-
-```sh
-npm i --save @xylabs/promise
-```
+## Documentation
 
-Using yarn:
+Coming Soon!
 
-```sh
-yarn add @xylabs/promise
-```
-
-## Documentation
-[Developer Reference](https://xylabs.github.io/sdk-js)
+Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 
 ## Maintainers
 
 -   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
--   [Joel Carter](https://github.com/JoelBCarter)
 -   [Matt Jones](https://github.com/jonesmac)
+-   [Joel Carter](https://github.com/JoelBCarter)
 -   [Jordan Trouw](https://github.com/jordantrouw)
 
 ## License
 
-See the [LICENSE](LICENSE) file for license details
+> See the [LICENSE](LICENSE) file for license details
 
 ## Credits
 
-[Made with 🔥and ❄️ by XY Labs](https://xylabs.com)
+[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
 
 [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
 
+[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
+[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
 [npm-badge]: https://img.shields.io/npm/v/@xylabs/promise.svg
 [npm-link]: https://www.npmjs.com/package/@xylabs/promise
+[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
+[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
+[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
+[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
+[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
+[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
 
 [npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/promise
 [npm-license-badge]: https://img.shields.io/npm/l/@xylabs/promise

package/dist/neutral/index.d.ts

@@ -1,66 +1,8 @@
-import { TypedValue } from '@xylabs/typeof';
-
-/**
- * For use with Promise.allSettled to filter only successful results
- * @param val
- * @returns
- */
-declare const fulfilled: <T>(val: PromiseSettledResult<T>) => val is PromiseFulfilledResult<T>;
-
-/**
- * For use with Promise.allSettled to reduce to only successful result values
- * @example <caption>Casting the initialValue provided to reduce</caption>
- * const resolved = Promise.resolve('resolved')
- * const rejected = Promise.reject('rejected')
- * const settled = await Promise.allSettled([resolved, rejected])
- * const results = settled.reduce(fulfilledValues, [] as string[])
- * // results === [ 'resolved' ]
- * @example <caption>Providing type parameter to reduce and initialValue type can be inferred</caption>
- * const resolved = Promise.resolve('resolved')
- * const rejected = Promise.reject('rejected')
- * const settled = await Promise.allSettled([resolved, rejected])
- * const results = settled.reduce<string[]>(fulfilledValues, [])
- * // results === [ 'resolved' ]
- * @param previousValue
- * @param currentValue
- * @returns
- */
-declare const fulfilledValues: <T>(previousValue: T[], currentValue: PromiseSettledResult<T>) => T[];
-
-interface PromiseType {
-    then: () => unknown;
-}
-type AnyNonPromise = Exclude<TypedValue, PromiseType>;
-declare const isPromise: (value: unknown) => value is Promise<unknown>;
-
-type PromiseExSubFunc<T, TResult = T> = (value: T) => TResult;
-type PromiseExFunc<T> = (resolve?: PromiseExSubFunc<T, void>, reject?: PromiseExSubFunc<T, void>) => void;
-type PromiseExValueFunc<V> = (value?: V) => boolean;
-declare class PromiseEx<T, V = void> extends Promise<T> {
-    cancelled?: boolean;
-    private _value?;
-    constructor(func: PromiseExFunc<T>, value?: V);
-    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null | undefined, onvalue?: (value?: V) => boolean): Promise<TResult1 | TResult2>;
-    value(onvalue?: (value?: V) => boolean): this;
-}
-
-/**
- * For use with Promise.allSettled to filter only rejected results
- * @param val
- * @returns
- */
-declare const rejected: <T>(val: PromiseSettledResult<T>) => val is PromiseRejectedResult;
-
-type Promisable<T, V = never> = PromiseEx<T, V> | Promise<T> | T;
-type PromisableArray<T, V = never> = Promisable<T[], V>;
-type OptionalPromisable<T, V = never> = Promisable<T | undefined, V>;
-type OptionalPromisableArray<T, V = never> = PromisableArray<T | undefined, V>;
-type NullablePromisable<T, V = never> = Promisable<T | null, V>;
-type NullablePromisableArray<T, V = never> = PromisableArray<T | null, V>;
-/** @description Used to document promises that are being used as Mutexes */
-type AsyncMutex<T> = Promise<T>;
-
-declare function toPromise<T>(value: Promisable<T>): Promise<T>;
-
-export { PromiseEx, fulfilled, fulfilledValues, isPromise, rejected, toPromise };
-export type { AnyNonPromise, AsyncMutex, NullablePromisable, NullablePromisableArray, OptionalPromisable, OptionalPromisableArray, Promisable, PromisableArray, PromiseExFunc, PromiseExSubFunc, PromiseExValueFunc, PromiseType };
+export { fulfilled } from './fulfilled.ts';
+export { fulfilledValues } from './fulfilledValues.ts';
+export * from './isPromise.ts';
+export * from './PromiseEx.ts';
+export { rejected } from './rejected.ts';
+export * from './toPromise.ts';
+export * from './types.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/neutral/spec/fulfilled.spec.d.ts

@@ -0,0 +1,2 @@
+import '@xylabs/vitest-extended';
+//# sourceMappingURL=fulfilled.spec.d.ts.map

package/dist/neutral/spec/fulfilled.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fulfilled.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/fulfilled.spec.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAA"}

package/dist/neutral/spec/fulfilledValues.spec.d.ts

@@ -0,0 +1,2 @@
+import '@xylabs/vitest-extended';
+//# sourceMappingURL=fulfilledValues.spec.d.ts.map

package/dist/neutral/spec/fulfilledValues.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fulfilledValues.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/fulfilledValues.spec.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAA"}

package/dist/neutral/spec/rejected.spec.d.ts

@@ -0,0 +1,2 @@
+import '@xylabs/vitest-extended';
+//# sourceMappingURL=rejected.spec.d.ts.map

package/dist/neutral/spec/rejected.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rejected.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/rejected.spec.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/promise",
-  "version": "4.13.15",
+  "version": "4.13.17",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "promise",
@@ -36,13 +36,13 @@
   "module": "./dist/neutral/index.mjs",
   "types": "./dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/typeof": "^4.13.15"
+    "@xylabs/typeof": "^4.13.17"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
-    "@xylabs/tsconfig": "^7.0.0-rc.20",
-    "@xylabs/typeof": "^4.13.15",
-    "@xylabs/vitest-extended": "^4.13.15",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
+    "@xylabs/tsconfig": "^7.0.0-rc.27",
+    "@xylabs/typeof": "^4.13.17",
+    "@xylabs/vitest-extended": "^4.13.17",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/build/neutral/index.d.ts

@@ -1,8 +0,0 @@
-export { fulfilled } from './fulfilled.ts';
-export { fulfilledValues } from './fulfilledValues.ts';
-export * from './isPromise.ts';
-export * from './PromiseEx.ts';
-export { rejected } from './rejected.ts';
-export * from './toPromise.ts';
-export * from './types.ts';
-//# sourceMappingURL=index.d.ts.map