@bifravst/aws-cdk-lambda-helpers 4.0.96 → 5.0.1

package/dist/layers/baseLayer/nodejs/node_modules/fp-ts/lib/ReadonlyMap.d.ts

@@ -0,0 +1,476 @@
+import { Compactable2 } from './Compactable'
+import { Either } from './Either'
+import { Eq } from './Eq'
+import { Filterable2 } from './Filterable'
+import { FilterableWithIndex2C } from './FilterableWithIndex'
+import { Foldable, Foldable1, Foldable2, Foldable2C, Foldable3 } from './Foldable'
+import { FoldableWithIndex2C } from './FoldableWithIndex'
+import { Functor2 } from './Functor'
+import { FunctorWithIndex2C } from './FunctorWithIndex'
+import { HKT, Kind, Kind2, Kind3, URIS, URIS2, URIS3 } from './HKT'
+import { Magma } from './Magma'
+import { Monoid } from './Monoid'
+import * as O from './Option'
+import { Ord } from './Ord'
+import { Predicate } from './Predicate'
+import { Refinement } from './Refinement'
+import { Semigroup } from './Semigroup'
+import { Separated } from './Separated'
+import { Show } from './Show'
+import { Traversable2C } from './Traversable'
+import { TraversableWithIndex2C } from './TraversableWithIndex'
+import { Unfoldable, Unfoldable1 } from './Unfoldable'
+import { Witherable2C } from './Witherable'
+import Option = O.Option
+/**
+ * @category conversions
+ * @since 2.5.0
+ */
+export declare const fromMap: <K, A>(m: Map<K, A>) => ReadonlyMap<K, A>
+/**
+ * @category conversions
+ * @since 2.5.0
+ */
+export declare function toMap<K, A>(m: ReadonlyMap<K, A>): Map<K, A>
+/**
+ * @category instances
+ * @since 2.5.0
+ */
+export declare function getShow<K, A>(SK: Show<K>, SA: Show<A>): Show<ReadonlyMap<K, A>>
+/**
+ * Calculate the number of key/value pairs in a map
+ *
+ * @since 2.5.0
+ */
+export declare const size: <K, A>(m: ReadonlyMap<K, A>) => number
+/**
+ * Test whether or not a map is empty
+ *
+ * @since 2.5.0
+ */
+export declare const isEmpty: <K, A>(m: ReadonlyMap<K, A>) => boolean
+/**
+ * Test whether or not a key exists in a map
+ *
+ * @since 2.5.0
+ */
+export declare function member<K>(E: Eq<K>): {
+  (k: K): <A>(m: ReadonlyMap<K, A>) => boolean
+  <A>(k: K, m: ReadonlyMap<K, A>): boolean
+}
+/**
+ * Test whether or not a value is a member of a map
+ *
+ * @since 2.5.0
+ */
+export declare function elem<A>(E: Eq<A>): {
+  (a: A): <K>(m: ReadonlyMap<K, A>) => boolean
+  <K>(a: A, m: ReadonlyMap<K, A>): boolean
+}
+/**
+ * Get a sorted `ReadonlyArray` of the keys contained in a `ReadonlyMap`.
+ *
+ * @since 2.5.0
+ */
+export declare const keys: <K>(O: Ord<K>) => <A>(m: ReadonlyMap<K, A>) => ReadonlyArray<K>
+/**
+ * Get a sorted `ReadonlyArray` of the values contained in a `ReadonlyMap`.
+ *
+ * @since 2.5.0
+ */
+export declare const values: <A>(O: Ord<A>) => <K>(m: ReadonlyMap<K, A>) => ReadonlyArray<A>
+/**
+ * @since 2.5.0
+ */
+export declare function collect<K>(
+  O: Ord<K>
+): <A, B>(f: (k: K, a: A) => B) => (m: ReadonlyMap<K, A>) => ReadonlyArray<B>
+/**
+ * Get a sorted `ReadonlyArray` of the key/value pairs contained in a `ReadonlyMap`.
+ *
+ * @category conversions
+ * @since 2.5.0
+ */
+export declare const toReadonlyArray: <K>(O: Ord<K>) => <A>(m: ReadonlyMap<K, A>) => ReadonlyArray<readonly [K, A]>
+/**
+ * Unfolds a map into a list of key/value pairs
+ *
+ * @category conversions
+ * @since 2.5.0
+ */
+export declare function toUnfoldable<K, F extends URIS>(
+  ord: Ord<K>,
+  U: Unfoldable1<F>
+): <A>(d: ReadonlyMap<K, A>) => Kind<F, readonly [K, A]>
+export declare function toUnfoldable<K, F>(
+  ord: Ord<K>,
+  U: Unfoldable<F>
+): <A>(d: ReadonlyMap<K, A>) => HKT<F, readonly [K, A]>
+/**
+ * Insert or replace a key/value pair in a `ReadonlyMap`.
+ *
+ * @since 2.10.0
+ */
+export declare const upsertAt: <K>(E: Eq<K>) => <A>(k: K, a: A) => (m: ReadonlyMap<K, A>) => ReadonlyMap<K, A>
+/**
+ * Delete a key and value from a map
+ *
+ * @since 2.5.0
+ */
+export declare const deleteAt: <K>(E: Eq<K>) => (k: K) => <A>(m: ReadonlyMap<K, A>) => ReadonlyMap<K, A>
+/**
+ * @since 2.5.0
+ */
+export declare const updateAt: <K>(E: Eq<K>) => <A>(k: K, a: A) => (m: ReadonlyMap<K, A>) => Option<ReadonlyMap<K, A>>
+/**
+ * @since 2.5.0
+ */
+export declare const modifyAt: <K>(
+  E: Eq<K>
+) => <A>(k: K, f: (a: A) => A) => (m: ReadonlyMap<K, A>) => Option<ReadonlyMap<K, A>>
+/**
+ * Delete a key and value from a map, returning the value as well as the subsequent map
+ *
+ * @since 2.5.0
+ */
+export declare function pop<K>(E: Eq<K>): (k: K) => <A>(m: ReadonlyMap<K, A>) => Option<readonly [A, ReadonlyMap<K, A>]>
+/**
+ * Lookup the value for a key in a `Map`.
+ * If the result is a `Some`, the existing key is also returned.
+ *
+ * @since 2.5.0
+ */
+export declare function lookupWithKey<K>(E: Eq<K>): {
+  (k: K): <A>(m: ReadonlyMap<K, A>) => Option<readonly [K, A]>
+  <A>(k: K, m: ReadonlyMap<K, A>): Option<readonly [K, A]>
+}
+/**
+ * Lookup the value for a key in a `Map`.
+ *
+ * @since 2.5.0
+ */
+export declare function lookup<K>(E: Eq<K>): {
+  (k: K): <A>(m: ReadonlyMap<K, A>) => Option<A>
+  <A>(k: K, m: ReadonlyMap<K, A>): Option<A>
+}
+/**
+ * Test whether or not one `Map` contains all of the keys and values contained in another `Map`
+ *
+ * @since 2.5.0
+ */
+export declare function isSubmap<K, A>(
+  SK: Eq<K>,
+  SA: Eq<A>
+): {
+  (that: ReadonlyMap<K, A>): (me: ReadonlyMap<K, A>) => boolean
+  (me: ReadonlyMap<K, A>, that: ReadonlyMap<K, A>): boolean
+}
+/**
+ * @since 2.5.0
+ */
+export declare const empty: ReadonlyMap<never, never>
+/**
+ * @category instances
+ * @since 2.5.0
+ */
+export declare function getEq<K, A>(SK: Eq<K>, SA: Eq<A>): Eq<ReadonlyMap<K, A>>
+/**
+ * Gets `Monoid` instance for Maps given `Semigroup` instance for their values
+ *
+ * @category instances
+ * @since 2.5.0
+ */
+export declare function getMonoid<K, A>(SK: Eq<K>, SA: Semigroup<A>): Monoid<ReadonlyMap<K, A>>
+/**
+ * Create a map with one key/value pair
+ *
+ * @category constructors
+ * @since 2.5.0
+ */
+export declare const singleton: <K, A>(k: K, a: A) => ReadonlyMap<K, A>
+/**
+ * Create a map from a foldable collection of key/value pairs, using the
+ * specified `Magma` to combine values for duplicate keys.
+ *
+ * @category constructors
+ * @since 2.5.0
+ */
+export declare function fromFoldable<F extends URIS3, K, A>(
+  E: Eq<K>,
+  M: Magma<A>,
+  F: Foldable3<F>
+): <R, E>(fka: Kind3<F, R, E, readonly [K, A]>) => ReadonlyMap<K, A>
+export declare function fromFoldable<F extends URIS2, K, A>(
+  E: Eq<K>,
+  M: Magma<A>,
+  F: Foldable2<F>
+): <E>(fka: Kind2<F, E, readonly [K, A]>) => ReadonlyMap<K, A>
+export declare function fromFoldable<F extends URIS, K, A>(
+  E: Eq<K>,
+  M: Magma<A>,
+  F: Foldable1<F>
+): (fka: Kind<F, readonly [K, A]>) => ReadonlyMap<K, A>
+export declare function fromFoldable<F, K, A>(
+  E: Eq<K>,
+  M: Magma<A>,
+  F: Foldable<F>
+): (fka: HKT<F, readonly [K, A]>) => ReadonlyMap<K, A>
+/**
+ * @since 2.10.0
+ */
+export declare const partitionMapWithIndex: <K, A, B, C>(
+  f: (k: K, a: A) => Either<B, C>
+) => (fa: ReadonlyMap<K, A>) => Separated<ReadonlyMap<K, B>, ReadonlyMap<K, C>>
+/**
+ * @since 2.10.0
+ */
+export declare function partitionWithIndex<K, A, B extends A>(
+  predicateWithIndex: (k: K, a: A) => a is B
+): (m: ReadonlyMap<K, A>) => Separated<ReadonlyMap<K, A>, ReadonlyMap<K, B>>
+export declare function partitionWithIndex<K, A>(
+  predicateWithIndex: (k: K, a: A) => boolean
+): <B extends A>(m: ReadonlyMap<K, B>) => Separated<ReadonlyMap<K, B>, ReadonlyMap<K, B>>
+export declare function partitionWithIndex<K, A>(
+  predicateWithIndex: (k: K, a: A) => boolean
+): (m: ReadonlyMap<K, A>) => Separated<ReadonlyMap<K, A>, ReadonlyMap<K, A>>
+/**
+ * @since 2.10.0
+ */
+export declare const filterMapWithIndex: <K, A, B>(
+  f: (k: K, a: A) => Option<B>
+) => (fa: ReadonlyMap<K, A>) => ReadonlyMap<K, B>
+/**
+ * @since 2.10.0
+ */
+export declare function filterWithIndex<K, A, B extends A>(
+  predicateWithIndex: (k: K, a: A) => a is B
+): (m: ReadonlyMap<K, A>) => ReadonlyMap<K, B>
+export declare function filterWithIndex<K, A>(
+  predicateWithIndex: (k: K, a: A) => boolean
+): <B extends A>(m: ReadonlyMap<K, B>) => ReadonlyMap<K, B>
+export declare function filterWithIndex<K, A>(
+  predicateWithIndex: (k: K, a: A) => boolean
+): (m: ReadonlyMap<K, A>) => ReadonlyMap<K, A>
+/**
+ * @category filtering
+ * @since 2.5.0
+ */
+export declare const compact: <K, A>(fa: ReadonlyMap<K, Option<A>>) => ReadonlyMap<K, A>
+/**
+ * @category filtering
+ * @since 2.5.0
+ */
+export declare const filter: {
+  <A, B extends A>(refinement: Refinement<A, B>): <K>(fa: ReadonlyMap<K, A>) => ReadonlyMap<K, B>
+  <A>(predicate: Predicate<A>): <K, B extends A>(fb: ReadonlyMap<K, B>) => ReadonlyMap<K, B>
+  <A>(predicate: Predicate<A>): <K>(fa: ReadonlyMap<K, A>) => ReadonlyMap<K, A>
+}
+/**
+ * @category filtering
+ * @since 2.5.0
+ */
+export declare const filterMap: <A, B>(f: (a: A) => Option<B>) => <K>(fa: ReadonlyMap<K, A>) => ReadonlyMap<K, B>
+/**
+ * `map` can be used to turn functions `(a: A) => B` into functions `(fa: F<A>) => F<B>` whose argument and return types
+ * use the type constructor `F` to represent some computational context.
+ *
+ * @category mapping
+ * @since 2.5.0
+ */
+export declare const map: <A, B>(f: (a: A) => B) => <K>(fa: ReadonlyMap<K, A>) => ReadonlyMap<K, B>
+/**
+ * @category mapping
+ * @since 2.7.1
+ */
+export declare const mapWithIndex: <K, A, B>(f: (k: K, a: A) => B) => (fa: ReadonlyMap<K, A>) => ReadonlyMap<K, B>
+/**
+ * @category filtering
+ * @since 2.5.0
+ */
+export declare const partition: {
+  <A, B extends A>(refinement: Refinement<A, B>): <K>(
+    fa: ReadonlyMap<K, A>
+  ) => Separated<ReadonlyMap<K, A>, ReadonlyMap<K, B>>
+  <A>(predicate: Predicate<A>): <K, B extends A>(
+    fb: ReadonlyMap<K, B>
+  ) => Separated<ReadonlyMap<K, B>, ReadonlyMap<K, B>>
+  <A>(predicate: Predicate<A>): <K>(fa: ReadonlyMap<K, A>) => Separated<ReadonlyMap<K, A>, ReadonlyMap<K, A>>
+}
+/**
+ * @category filtering
+ * @since 2.5.0
+ */
+export declare const partitionMap: <A, B, C>(
+  f: (a: A) => Either<B, C>
+) => <K>(fa: ReadonlyMap<K, A>) => Separated<ReadonlyMap<K, B>, ReadonlyMap<K, C>>
+/**
+ * @category filtering
+ * @since 2.5.0
+ */
+export declare const separate: <K, A, B>(
+  fa: ReadonlyMap<K, Either<A, B>>
+) => Separated<ReadonlyMap<K, A>, ReadonlyMap<K, B>>
+/**
+ * @category type lambdas
+ * @since 2.5.0
+ */
+export declare const URI = 'ReadonlyMap'
+/**
+ * @category type lambdas
+ * @since 2.5.0
+ */
+export type URI = typeof URI
+declare module './HKT' {
+  interface URItoKind2<E, A> {
+    readonly [URI]: ReadonlyMap<E, A>
+  }
+}
+/**
+ * @category instances
+ * @since 2.11.0
+ */
+export declare const getUnionSemigroup: <K, A>(E: Eq<K>, S: Semigroup<A>) => Semigroup<ReadonlyMap<K, A>>
+/**
+ * @category instances
+ * @since 2.11.0
+ */
+export declare const getUnionMonoid: <K, A>(E: Eq<K>, S: Semigroup<A>) => Monoid<ReadonlyMap<K, A>>
+/**
+ * @category instances
+ * @since 2.11.0
+ */
+export declare const getIntersectionSemigroup: <K, A>(E: Eq<K>, S: Semigroup<A>) => Semigroup<ReadonlyMap<K, A>>
+/**
+ * @category instances
+ * @since 2.11.0
+ */
+export declare const getDifferenceMagma: <K>(E: Eq<K>) => <A>() => Magma<ReadonlyMap<K, A>>
+/**
+ * @category filtering
+ * @since 2.5.0
+ */
+export declare function getFilterableWithIndex<K = never>(): FilterableWithIndex2C<URI, K, K>
+/**
+ * @category instances
+ * @since 2.7.0
+ */
+export declare const Functor: Functor2<URI>
+/**
+ * @category mapping
+ * @since 2.10.0
+ */
+export declare const flap: <A>(a: A) => <E, B>(fab: Kind2<'ReadonlyMap', E, (a: A) => B>) => Kind2<'ReadonlyMap', E, B>
+/**
+ * @category instances
+ * @since 2.10.0
+ */
+export declare const getFunctorWithIndex: <K = never>() => FunctorWithIndex2C<URI, K, K>
+/**
+ * @category instances
+ * @since 2.7.0
+ */
+export declare const Compactable: Compactable2<URI>
+/**
+ * @category instances
+ * @since 2.7.0
+ */
+export declare const Filterable: Filterable2<URI>
+/**
+ * @category folding
+ * @since 2.11.0
+ */
+export declare const reduce: <K>(O: Ord<K>) => <B, A>(b: B, f: (b: B, a: A) => B) => (m: ReadonlyMap<K, A>) => B
+/**
+ * @category folding
+ * @since 2.11.0
+ */
+export declare const foldMap: <K>(O: Ord<K>) => <M>(M: Monoid<M>) => <A>(f: (a: A) => M) => (m: ReadonlyMap<K, A>) => M
+/**
+ * @category folding
+ * @since 2.11.0
+ */
+export declare const reduceRight: <K>(O: Ord<K>) => <B, A>(b: B, f: (a: A, b: B) => B) => (m: ReadonlyMap<K, A>) => B
+/**
+ * @category folding
+ * @since 2.10.0
+ */
+export declare const getFoldable: <K>(O: Ord<K>) => Foldable2C<URI, K>
+/**
+ * @category folding
+ * @since 2.11.0
+ */
+export declare const reduceWithIndex: <K>(
+  O: Ord<K>
+) => <B, A>(b: B, f: (k: K, b: B, a: A) => B) => (m: ReadonlyMap<K, A>) => B
+/**
+ * @category folding
+ * @since 2.11.0
+ */
+export declare const foldMapWithIndex: <K>(
+  O: Ord<K>
+) => <M>(M: Monoid<M>) => <A>(f: (k: K, a: A) => M) => (m: ReadonlyMap<K, A>) => M
+/**
+ * @category folding
+ * @since 2.11.0
+ */
+export declare const reduceRightWithIndex: <K>(
+  O: Ord<K>
+) => <B, A>(b: B, f: (k: K, a: A, b: B) => B) => (m: ReadonlyMap<K, A>) => B
+/**
+ * @category folding
+ * @since 2.10.0
+ */
+export declare const getFoldableWithIndex: <K>(O: Ord<K>) => FoldableWithIndex2C<URI, K, K>
+/**
+ * @category traversing
+ * @since 2.10.0
+ */
+export declare const getTraversable: <K>(O: Ord<K>) => Traversable2C<URI, K>
+/**
+ * @category traversing
+ * @since 2.10.0
+ */
+export declare const getTraversableWithIndex: <K>(O: Ord<K>) => TraversableWithIndex2C<URI, K, K>
+/**
+ * @category filtering
+ * @since 2.5.0
+ */
+export declare function getWitherable<K>(O: Ord<K>): Witherable2C<URI, K> & TraversableWithIndex2C<URI, K, K>
+/**
+ * @since 2.11.0
+ */
+export declare const union: <K, A>(
+  E: Eq<K>,
+  M: Magma<A>
+) => (second: ReadonlyMap<K, A>) => (first: ReadonlyMap<K, A>) => ReadonlyMap<K, A>
+/**
+ * @since 2.11.0
+ */
+export declare const intersection: <K, A>(
+  E: Eq<K>,
+  M: Magma<A>
+) => (second: ReadonlyMap<K, A>) => (first: ReadonlyMap<K, A>) => ReadonlyMap<K, A>
+/**
+ * @since 2.11.0
+ */
+export declare const difference: <K>(
+  E: Eq<K>
+) => <A>(_second: ReadonlyMap<K, A>) => (first: ReadonlyMap<K, A>) => ReadonlyMap<K, A>
+/**
+ * Use [`upsertAt`](#upsertat) instead.
+ *
+ @category zone of death
+ * @since 2.5.0
+ * @deprecated
+ */
+export declare const insertAt: <K>(E: Eq<K>) => <A>(k: K, a: A) => (m: ReadonlyMap<K, A>) => ReadonlyMap<K, A>
+/**
+ * This instance is deprecated, use small, specific instances instead.
+ * For example if a function needs a `Functor` instance, pass `RM.Functor` instead of `RM.readonlyMap`
+ * (where `RM` is from `import RM from 'fp-ts/ReadonlyMap'`)
+ *
+ * @category zone of death
+ * @since 2.5.0
+ * @deprecated
+ */
+export declare const readonlyMap: Filterable2<URI>