1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347 |
- /**
- * This file provides type definitions for use with the Flow type checker.
- *
- * An important caveat when using these definitions is that the types for
- * `Collection.Keyed`, `Collection.Indexed`, `Seq.Keyed`, and so on are stubs.
- * When referring to those types, you can get the proper definitions by
- * importing the types `KeyedCollection`, `IndexedCollection`, `KeyedSeq`, etc.
- * For example,
- *
- * import { Seq } from 'immutable'
- * import type { IndexedCollection, IndexedSeq } from 'immutable'
- *
- * const someSeq: IndexedSeq<number> = Seq.Indexed.of(1, 2, 3)
- *
- * function takesASeq<T, TS: IndexedCollection<T>>(iter: TS): TS {
- * return iter.butLast()
- * }
- *
- * takesASeq(someSeq)
- *
- * @flow strict
- */
- // Helper type that represents plain objects allowed as arguments to
- // some constructors and functions.
- type PlainObjInput<K, V> = { +[key: K]: V, __proto__: null };
- type K<T> = $Keys<T>;
- // Helper types to extract the "keys" and "values" use by the *In() methods.
- type $KeyOf<C> = $Call<
- (<K>(?_Collection<K, mixed>) => K) &
- (<T>(?$ReadOnlyArray<T>) => number) &
- (<T>(?RecordInstance<T> | T) => $Keys<T>) &
- (<T: Object>(T) => $Keys<T>),
- C
- >;
- type $ValOf<C, K = $KeyOf<C>> = $Call<
- (<V>(?_Collection<any, V>) => V) &
- (<T>(?$ReadOnlyArray<T>) => T) &
- (<T, K: $Keys<T>>(?RecordInstance<T> | T, K) => $ElementType<T, K>) &
- (<T: Object>(T) => $Values<T>),
- C,
- K
- >;
- type $IterableOf<C> = $Call<
- (<V: Array<any> | IndexedCollection<any> | SetCollection<any>>(
- V
- ) => Iterable<$ValOf<V>>) &
- (<
- V:
- | KeyedCollection<any, any>
- | RecordInstance<any>
- | PlainObjInput<any, any>
- >(
- V
- ) => Iterable<[$KeyOf<V>, $ValOf<V>]>),
- C
- >;
- declare class _Collection<K, +V> implements ValueObject {
- equals(other: mixed): boolean;
- hashCode(): number;
- get(key: K, ..._: []): V | void;
- get<NSV>(key: K, notSetValue: NSV): V | NSV;
- has(key: K): boolean;
- includes(value: V): boolean;
- contains(value: V): boolean;
- first<NSV>(notSetValue?: NSV): V | NSV;
- last<NSV>(notSetValue?: NSV): V | NSV;
- hasIn(keyPath: Iterable<mixed>): boolean;
- getIn(keyPath: [], notSetValue?: mixed): this;
- getIn<NSV>(keyPath: [K], notSetValue: NSV): V | NSV;
- getIn<NSV, K2: $KeyOf<V>>(
- keyPath: [K, K2],
- notSetValue: NSV
- ): $ValOf<V, K2> | NSV;
- getIn<NSV, K2: $KeyOf<V>, K3: $KeyOf<$ValOf<V, K2>>>(
- keyPath: [K, K2, K3],
- notSetValue: NSV
- ): $ValOf<$ValOf<V, K2>, K3> | NSV;
- getIn<
- NSV,
- K2: $KeyOf<V>,
- K3: $KeyOf<$ValOf<V, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<V, K2>, K3>>
- >(
- keyPath: [K, K2, K3, K4],
- notSetValue: NSV
- ): $ValOf<$ValOf<$ValOf<V, K2>, K3>, K4> | NSV;
- getIn<
- NSV,
- K2: $KeyOf<V>,
- K3: $KeyOf<$ValOf<V, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<V, K2>, K3>>,
- K5: $KeyOf<$ValOf<$ValOf<$ValOf<V, K2>, K3>, K4>>
- >(
- keyPath: [K, K2, K3, K4, K5],
- notSetValue: NSV
- ): $ValOf<$ValOf<$ValOf<$ValOf<V, K2>, K3>, K4>, K5> | NSV;
- update<U>(updater: (value: this) => U): U;
- toJS(): Array<any> | { [key: string]: mixed };
- toJSON(): Array<V> | { [key: string]: V };
- toArray(): Array<V> | Array<[K, V]>;
- toObject(): { [key: string]: V };
- toMap(): Map<K, V>;
- toOrderedMap(): OrderedMap<K, V>;
- toSet(): Set<V>;
- toOrderedSet(): OrderedSet<V>;
- toList(): List<V>;
- toStack(): Stack<V>;
- toSeq(): Seq<K, V>;
- toKeyedSeq(): KeyedSeq<K, V>;
- toIndexedSeq(): IndexedSeq<V>;
- toSetSeq(): SetSeq<V>;
- keys(): Iterator<K>;
- values(): Iterator<V>;
- entries(): Iterator<[K, V]>;
- keySeq(): IndexedSeq<K>;
- valueSeq(): IndexedSeq<V>;
- entrySeq(): IndexedSeq<[K, V]>;
- reverse(): this;
- sort(comparator?: (valueA: V, valueB: V) => number): this;
- sortBy<C>(
- comparatorValueMapper: (value: V, key: K, iter: this) => C,
- comparator?: (valueA: C, valueB: C) => number
- ): this;
- groupBy<G>(
- grouper: (value: V, key: K, iter: this) => G,
- context?: mixed
- ): KeyedSeq<G, this>;
- forEach(
- sideEffect: (value: V, key: K, iter: this) => any,
- context?: mixed
- ): number;
- slice(begin?: number, end?: number): this;
- rest(): this;
- butLast(): this;
- skip(amount: number): this;
- skipLast(amount: number): this;
- skipWhile(
- predicate: (value: V, key: K, iter: this) => mixed,
- context?: mixed
- ): this;
- skipUntil(
- predicate: (value: V, key: K, iter: this) => mixed,
- context?: mixed
- ): this;
- take(amount: number): this;
- takeLast(amount: number): this;
- takeWhile(
- predicate: (value: V, key: K, iter: this) => mixed,
- context?: mixed
- ): this;
- takeUntil(
- predicate: (value: V, key: K, iter: this) => mixed,
- context?: mixed
- ): this;
- filterNot(
- predicate: (value: V, key: K, iter: this) => mixed,
- context?: mixed
- ): this;
- reduce<R>(
- reducer: (reduction: R, value: V, key: K, iter: this) => R,
- initialReduction: R,
- context?: mixed
- ): R;
- reduce<R>(reducer: (reduction: V | R, value: V, key: K, iter: this) => R): R;
- reduceRight<R>(
- reducer: (reduction: R, value: V, key: K, iter: this) => R,
- initialReduction: R,
- context?: mixed
- ): R;
- reduceRight<R>(
- reducer: (reduction: V | R, value: V, key: K, iter: this) => R
- ): R;
- every(
- predicate: (value: V, key: K, iter: this) => mixed,
- context?: mixed
- ): boolean;
- some(
- predicate: (value: V, key: K, iter: this) => mixed,
- context?: mixed
- ): boolean;
- join(separator?: string): string;
- isEmpty(): boolean;
- count(
- predicate?: (value: V, key: K, iter: this) => mixed,
- context?: mixed
- ): number;
- countBy<G>(
- grouper: (value: V, key: K, iter: this) => G,
- context?: mixed
- ): Map<G, number>;
- find<NSV>(
- predicate: (value: V, key: K, iter: this) => mixed,
- context?: mixed,
- notSetValue?: NSV
- ): V | NSV;
- findLast<NSV>(
- predicate: (value: V, key: K, iter: this) => mixed,
- context?: mixed,
- notSetValue?: NSV
- ): V | NSV;
- findEntry(predicate: (value: V, key: K, iter: this) => mixed): [K, V] | void;
- findLastEntry(
- predicate: (value: V, key: K, iter: this) => mixed
- ): [K, V] | void;
- findKey(
- predicate: (value: V, key: K, iter: this) => mixed,
- context?: mixed
- ): K | void;
- findLastKey(
- predicate: (value: V, key: K, iter: this) => mixed,
- context?: mixed
- ): K | void;
- keyOf(searchValue: V): K | void;
- lastKeyOf(searchValue: V): K | void;
- max(comparator?: (valueA: V, valueB: V) => number): V;
- maxBy<C>(
- comparatorValueMapper: (value: V, key: K, iter: this) => C,
- comparator?: (valueA: C, valueB: C) => number
- ): V;
- min(comparator?: (valueA: V, valueB: V) => number): V;
- minBy<C>(
- comparatorValueMapper: (value: V, key: K, iter: this) => C,
- comparator?: (valueA: C, valueB: C) => number
- ): V;
- isSubset(iter: Iterable<V>): boolean;
- isSuperset(iter: Iterable<V>): boolean;
- }
- declare function isImmutable(
- maybeImmutable: mixed
- ): boolean %checks(maybeImmutable instanceof Collection);
- declare function isCollection(
- maybeCollection: mixed
- ): boolean %checks(maybeCollection instanceof Collection);
- declare function isKeyed(
- maybeKeyed: mixed
- ): boolean %checks(maybeKeyed instanceof KeyedCollection);
- declare function isIndexed(
- maybeIndexed: mixed
- ): boolean %checks(maybeIndexed instanceof IndexedCollection);
- declare function isAssociative(
- maybeAssociative: mixed
- ): boolean %checks(maybeAssociative instanceof KeyedCollection ||
- maybeAssociative instanceof IndexedCollection);
- declare function isOrdered(
- maybeOrdered: mixed
- ): boolean %checks(maybeOrdered instanceof IndexedCollection ||
- maybeOrdered instanceof OrderedMap ||
- maybeOrdered instanceof OrderedSet);
- declare function isValueObject(maybeValue: mixed): boolean;
- declare function isSeq(maybeSeq: any): boolean %checks(maybeSeq instanceof Seq);
- declare function isList(maybeList: any): boolean %checks(maybeList instanceof
- List);
- declare function isMap(maybeMap: any): boolean %checks(maybeMap instanceof Map);
- declare function isOrderedMap(
- maybeOrderedMap: any
- ): boolean %checks(maybeOrderedMap instanceof OrderedMap);
- declare function isStack(maybeStack: any): boolean %checks(maybeStack instanceof
- Stack);
- declare function isSet(maybeSet: any): boolean %checks(maybeSet instanceof Set);
- declare function isOrderedSet(
- maybeOrderedSet: any
- ): boolean %checks(maybeOrderedSet instanceof OrderedSet);
- declare function isRecord(
- maybeRecord: any
- ): boolean %checks(maybeRecord instanceof Record);
- declare interface ValueObject {
- equals(other: mixed): boolean;
- hashCode(): number;
- }
- declare class Collection<K, +V> extends _Collection<K, V> {
- static Keyed: typeof KeyedCollection;
- static Indexed: typeof IndexedCollection;
- static Set: typeof SetCollection;
- static isCollection: typeof isCollection;
- static isKeyed: typeof isKeyed;
- static isIndexed: typeof isIndexed;
- static isAssociative: typeof isAssociative;
- static isOrdered: typeof isOrdered;
- }
- declare class KeyedCollection<K, +V> extends Collection<K, V> {
- static <K, V>(
- values?: Iterable<[K, V]> | PlainObjInput<K, V>
- ): KeyedCollection<K, V>;
- toJS(): { [key: string]: mixed };
- toJSON(): { [key: string]: V };
- toArray(): Array<[K, V]>;
- @@iterator(): Iterator<[K, V]>;
- toSeq(): KeyedSeq<K, V>;
- flip(): KeyedCollection<V, K>;
- concat<KC, VC>(
- ...iters: Array<Iterable<[KC, VC]> | PlainObjInput<KC, VC>>
- ): KeyedCollection<K | KC, V | VC>;
- filter(predicate: typeof Boolean): KeyedCollection<K, $NonMaybeType<V>>;
- filter(
- predicate: (value: V, key: K, iter: this) => mixed,
- context?: mixed
- ): KeyedCollection<K, V>;
- map<M>(
- mapper: (value: V, key: K, iter: this) => M,
- context?: mixed
- ): KeyedCollection<K, M>;
- mapKeys<M>(
- mapper: (key: K, value: V, iter: this) => M,
- context?: mixed
- ): KeyedCollection<M, V>;
- mapEntries<KM, VM>(
- mapper: (entry: [K, V], index: number, iter: this) => [KM, VM],
- context?: mixed
- ): KeyedCollection<KM, VM>;
- flatMap<KM, VM>(
- mapper: (value: V, key: K, iter: this) => Iterable<[KM, VM]>,
- context?: mixed
- ): KeyedCollection<KM, VM>;
- flatten(depth?: number): KeyedCollection<any, any>;
- flatten(shallow?: boolean): KeyedCollection<any, any>;
- }
- Collection.Keyed = KeyedCollection;
- declare class IndexedCollection<+T> extends Collection<number, T> {
- static <T>(iter?: Iterable<T>): IndexedCollection<T>;
- toJS(): Array<mixed>;
- toJSON(): Array<T>;
- toArray(): Array<T>;
- @@iterator(): Iterator<T>;
- toSeq(): IndexedSeq<T>;
- fromEntrySeq<K, V>(): KeyedSeq<K, V>;
- interpose(separator: T): this;
- interleave(...collections: Iterable<T>[]): this;
- splice(index: number, removeNum: number, ...values: T[]): this;
- zip<A>(a: Iterable<A>, ..._: []): IndexedCollection<[T, A]>;
- zip<A, B>(
- a: Iterable<A>,
- b: Iterable<B>,
- ..._: []
- ): IndexedCollection<[T, A, B]>;
- zip<A, B, C>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- ..._: []
- ): IndexedCollection<[T, A, B, C]>;
- zip<A, B, C, D>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- ..._: []
- ): IndexedCollection<[T, A, B, C, D]>;
- zip<A, B, C, D, E>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- e: Iterable<E>,
- ..._: []
- ): IndexedCollection<[T, A, B, C, D, E]>;
- zipAll<A>(a: Iterable<A>, ..._: []): IndexedCollection<[T | void, A | void]>;
- zipAll<A, B>(
- a: Iterable<A>,
- b: Iterable<B>,
- ..._: []
- ): IndexedCollection<[T | void, A | void, B | void]>;
- zipAll<A, B, C>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- ..._: []
- ): IndexedCollection<[T | void, A | void, B | void, C | void]>;
- zipAll<A, B, C, D>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- ..._: []
- ): IndexedCollection<[T | void, A | void, B | void, C | void, D | void]>;
- zipAll<A, B, C, D, E>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- e: Iterable<E>,
- ..._: []
- ): IndexedCollection<
- [T | void, A | void, B | void, C | void, D | void, E | void]
- >;
- zipWith<A, R>(
- zipper: (value: T, a: A) => R,
- a: Iterable<A>,
- ..._: []
- ): IndexedCollection<R>;
- zipWith<A, B, R>(
- zipper: (value: T, a: A, b: B) => R,
- a: Iterable<A>,
- b: Iterable<B>,
- ..._: []
- ): IndexedCollection<R>;
- zipWith<A, B, C, R>(
- zipper: (value: T, a: A, b: B, c: C) => R,
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- ..._: []
- ): IndexedCollection<R>;
- zipWith<A, B, C, D, R>(
- zipper: (value: T, a: A, b: B, c: C, d: D) => R,
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- ..._: []
- ): IndexedCollection<R>;
- zipWith<A, B, C, D, E, R>(
- zipper: (value: T, a: A, b: B, c: C, d: D, e: E) => R,
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- e: Iterable<E>,
- ..._: []
- ): IndexedCollection<R>;
- indexOf(searchValue: T): number;
- lastIndexOf(searchValue: T): number;
- findIndex(
- predicate: (value: T, index: number, iter: this) => mixed,
- context?: mixed
- ): number;
- findLastIndex(
- predicate: (value: T, index: number, iter: this) => mixed,
- context?: mixed
- ): number;
- concat<C>(...iters: Array<Iterable<C> | C>): IndexedCollection<T | C>;
- filter(predicate: typeof Boolean): IndexedCollection<$NonMaybeType<T>>;
- filter(
- predicate: (value: T, index: number, iter: this) => mixed,
- context?: mixed
- ): IndexedCollection<T>;
- map<M>(
- mapper: (value: T, index: number, iter: this) => M,
- context?: mixed
- ): IndexedCollection<M>;
- flatMap<M>(
- mapper: (value: T, index: number, iter: this) => Iterable<M>,
- context?: mixed
- ): IndexedCollection<M>;
- flatten(depth?: number): IndexedCollection<any>;
- flatten(shallow?: boolean): IndexedCollection<any>;
- }
- declare class SetCollection<+T> extends Collection<T, T> {
- static <T>(iter?: Iterable<T>): SetCollection<T>;
- toJS(): Array<mixed>;
- toJSON(): Array<T>;
- toArray(): Array<T>;
- @@iterator(): Iterator<T>;
- toSeq(): SetSeq<T>;
- concat<U>(...collections: Iterable<U>[]): SetCollection<T | U>;
- // `filter`, `map` and `flatMap` cannot be defined further up the hierarchy,
- // because the implementation for `KeyedCollection` allows the value type to
- // change without constraining the key type. That does not work for
- // `SetCollection` - the value and key types *must* match.
- filter(predicate: typeof Boolean): SetCollection<$NonMaybeType<T>>;
- filter(
- predicate: (value: T, value: T, iter: this) => mixed,
- context?: mixed
- ): SetCollection<T>;
- map<M>(
- mapper: (value: T, value: T, iter: this) => M,
- context?: mixed
- ): SetCollection<M>;
- flatMap<M>(
- mapper: (value: T, value: T, iter: this) => Iterable<M>,
- context?: mixed
- ): SetCollection<M>;
- flatten(depth?: number): SetCollection<any>;
- flatten(shallow?: boolean): SetCollection<any>;
- }
- declare function isSeq(maybeSeq: mixed): boolean %checks(maybeSeq instanceof
- Seq);
- declare class Seq<K, +V> extends _Collection<K, V> {
- static Keyed: typeof KeyedSeq;
- static Indexed: typeof IndexedSeq;
- static Set: typeof SetSeq;
- static <K, V>(values: KeyedSeq<K, V>): KeyedSeq<K, V>;
- static <T>(values: SetSeq<T>): SetSeq<K, V>;
- static <T>(values: Iterable<T>): IndexedSeq<T>;
- static <K, V>(values?: PlainObjInput<K, V>): KeyedSeq<K, V>;
- static isSeq: typeof isSeq;
- size: number | void;
- cacheResult(): this;
- toSeq(): this;
- }
- declare class KeyedSeq<K, +V> extends Seq<K, V> mixins KeyedCollection<K, V> {
- static <K, V>(
- values?: Iterable<[K, V]> | PlainObjInput<K, V>
- ): KeyedSeq<K, V>;
- // Override specialized return types
- flip(): KeyedSeq<V, K>;
- concat<KC, VC>(
- ...iters: Array<Iterable<[KC, VC]> | PlainObjInput<KC, VC>>
- ): KeyedSeq<K | KC, V | VC>;
- filter(predicate: typeof Boolean): KeyedSeq<K, $NonMaybeType<V>>;
- filter(
- predicate: (value: V, key: K, iter: this) => mixed,
- context?: mixed
- ): KeyedSeq<K, V>;
- map<M>(
- mapper: (value: V, key: K, iter: this) => M,
- context?: mixed
- ): KeyedSeq<K, M>;
- mapKeys<M>(
- mapper: (key: K, value: V, iter: this) => M,
- context?: mixed
- ): KeyedSeq<M, V>;
- mapEntries<KM, VM>(
- mapper: (entry: [K, V], index: number, iter: this) => [KM, VM],
- context?: mixed
- ): KeyedSeq<KM, VM>;
- flatMap<KM, VM>(
- mapper: (value: V, key: K, iter: this) => Iterable<[KM, VM]>,
- context?: mixed
- ): KeyedSeq<KM, VM>;
- flatten(depth?: number): KeyedSeq<any, any>;
- flatten(shallow?: boolean): KeyedSeq<any, any>;
- }
- declare class IndexedSeq<+T>
- extends Seq<number, T>
- mixins IndexedCollection<T>
- {
- static <T>(values?: Iterable<T>): IndexedSeq<T>;
- static of<T>(...values: T[]): IndexedSeq<T>;
- // Override specialized return types
- concat<C>(...iters: Array<Iterable<C> | C>): IndexedSeq<T | C>;
- filter(predicate: typeof Boolean): IndexedSeq<$NonMaybeType<T>>;
- filter(
- predicate: (value: T, index: number, iter: this) => mixed,
- context?: mixed
- ): IndexedSeq<T>;
- map<M>(
- mapper: (value: T, index: number, iter: this) => M,
- context?: mixed
- ): IndexedSeq<M>;
- flatMap<M>(
- mapper: (value: T, index: number, iter: this) => Iterable<M>,
- context?: mixed
- ): IndexedSeq<M>;
- flatten(depth?: number): IndexedSeq<any>;
- flatten(shallow?: boolean): IndexedSeq<any>;
- zip<A>(a: Iterable<A>, ..._: []): IndexedSeq<[T, A]>;
- zip<A, B>(a: Iterable<A>, b: Iterable<B>, ..._: []): IndexedSeq<[T, A, B]>;
- zip<A, B, C>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- ..._: []
- ): IndexedSeq<[T, A, B, C]>;
- zip<A, B, C, D>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- ..._: []
- ): IndexedSeq<[T, A, B, C, D]>;
- zip<A, B, C, D, E>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- e: Iterable<E>,
- ..._: []
- ): IndexedSeq<[T, A, B, C, D, E]>;
- zipAll<A>(a: Iterable<A>, ..._: []): IndexedSeq<[T | void, A | void]>;
- zipAll<A, B>(
- a: Iterable<A>,
- b: Iterable<B>,
- ..._: []
- ): IndexedSeq<[T | void, A | void, B | void]>;
- zipAll<A, B, C>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- ..._: []
- ): IndexedSeq<[T | void, A | void, B | void, C | void]>;
- zipAll<A, B, C, D>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- ..._: []
- ): IndexedSeq<[T | void, A | void, B | void, C | void, D | void]>;
- zipAll<A, B, C, D, E>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- e: Iterable<E>,
- ..._: []
- ): IndexedSeq<[T | void, A | void, B | void, C | void, D | void, E | void]>;
- zipWith<A, R>(
- zipper: (value: T, a: A) => R,
- a: Iterable<A>,
- ..._: []
- ): IndexedSeq<R>;
- zipWith<A, B, R>(
- zipper: (value: T, a: A, b: B) => R,
- a: Iterable<A>,
- b: Iterable<B>,
- ..._: []
- ): IndexedSeq<R>;
- zipWith<A, B, C, R>(
- zipper: (value: T, a: A, b: B, c: C) => R,
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- ..._: []
- ): IndexedSeq<R>;
- zipWith<A, B, C, D, R>(
- zipper: (value: T, a: A, b: B, c: C, d: D) => R,
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- ..._: []
- ): IndexedSeq<R>;
- zipWith<A, B, C, D, E, R>(
- zipper: (value: T, a: A, b: B, c: C, d: D, e: E) => R,
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- e: Iterable<E>,
- ..._: []
- ): IndexedSeq<R>;
- }
- declare class SetSeq<+T> extends Seq<T, T> mixins SetCollection<T> {
- static <T>(values?: Iterable<T>): SetSeq<T>;
- static of<T>(...values: T[]): SetSeq<T>;
- // Override specialized return types
- concat<U>(...collections: Iterable<U>[]): SetSeq<T | U>;
- filter(predicate: typeof Boolean): SetSeq<$NonMaybeType<T>>;
- filter(
- predicate: (value: T, value: T, iter: this) => mixed,
- context?: mixed
- ): SetSeq<T>;
- map<M>(
- mapper: (value: T, value: T, iter: this) => M,
- context?: mixed
- ): SetSeq<M>;
- flatMap<M>(
- mapper: (value: T, value: T, iter: this) => Iterable<M>,
- context?: mixed
- ): SetSeq<M>;
- flatten(depth?: number): SetSeq<any>;
- flatten(shallow?: boolean): SetSeq<any>;
- }
- declare class UpdatableInCollection<K, +V> {
- setIn<S>(keyPath: [], value: S): S;
- setIn(keyPath: [K], value: V): this;
- setIn<K2: $KeyOf<V>, S: $ValOf<V, K2>>(keyPath: [K, K2], value: S): this;
- setIn<K2: $KeyOf<V>, K3: $KeyOf<$ValOf<V, K2>>, S: $ValOf<$ValOf<V, K2>, K3>>(
- keyPath: [K, K2, K3],
- value: S
- ): this;
- setIn<
- K2: $KeyOf<V>,
- K3: $KeyOf<$ValOf<V, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<V, K2>, K3>>,
- S: $ValOf<$ValOf<$ValOf<V, K2>, K3>, K4>
- >(
- keyPath: [K, K2, K3, K4],
- value: S
- ): this;
- setIn<
- K2: $KeyOf<V>,
- K3: $KeyOf<$ValOf<V, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<V, K2>, K3>>,
- K5: $KeyOf<$ValOf<$ValOf<$ValOf<V, K2>, K3>, K4>>,
- S: $ValOf<$ValOf<$ValOf<$ValOf<V, K2>, K3>, K4>, K5>
- >(
- keyPath: [K, K2, K3, K4, K5],
- value: S
- ): this;
- deleteIn(keyPath: []): void;
- deleteIn(keyPath: [K]): this;
- deleteIn<K2: $KeyOf<V>>(keyPath: [K, K2]): this;
- deleteIn<K2: $KeyOf<V>, K3: $KeyOf<$ValOf<V, K2>>>(
- keyPath: [K, K2, K3]
- ): this;
- deleteIn<
- K2: $KeyOf<V>,
- K3: $KeyOf<$ValOf<V, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<V, K2>, K3>>
- >(
- keyPath: [K, K2, K3, K4]
- ): this;
- deleteIn<
- K2: $KeyOf<V>,
- K3: $KeyOf<$ValOf<V, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<V, K2>, K3>>,
- K5: $KeyOf<$ValOf<$ValOf<$ValOf<V, K2>, K3>, K4>>
- >(
- keyPath: [K, K2, K3, K4, K5]
- ): this;
- removeIn(keyPath: []): void;
- removeIn(keyPath: [K]): this;
- removeIn<K2: $KeyOf<V>>(keyPath: [K, K2]): this;
- removeIn<K2: $KeyOf<V>, K3: $KeyOf<$ValOf<V, K2>>>(
- keyPath: [K, K2, K3]
- ): this;
- removeIn<
- K2: $KeyOf<V>,
- K3: $KeyOf<$ValOf<V, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<V, K2>, K3>>
- >(
- keyPath: [K, K2, K3, K4]
- ): this;
- removeIn<
- K2: $KeyOf<V>,
- K3: $KeyOf<$ValOf<V, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<V, K2>, K3>>,
- K5: $KeyOf<$ValOf<$ValOf<$ValOf<V, K2>, K3>, K4>>
- >(
- keyPath: [K, K2, K3, K4, K5]
- ): this;
- updateIn<U>(keyPath: [], notSetValue: mixed, updater: (value: this) => U): U;
- updateIn<U>(keyPath: [], updater: (value: this) => U): U;
- updateIn<NSV>(keyPath: [K], notSetValue: NSV, updater: (value: V) => V): this;
- updateIn(keyPath: [K], updater: (value: V) => V): this;
- updateIn<NSV, K2: $KeyOf<V>, S: $ValOf<V, K2>>(
- keyPath: [K, K2],
- notSetValue: NSV,
- updater: (value: $ValOf<V, K2> | NSV) => S
- ): this;
- updateIn<K2: $KeyOf<V>, S: $ValOf<V, K2>>(
- keyPath: [K, K2],
- updater: (value: $ValOf<V, K2>) => S
- ): this;
- updateIn<
- NSV,
- K2: $KeyOf<V>,
- K3: $KeyOf<$ValOf<V, K2>>,
- S: $ValOf<$ValOf<V, K2>, K3>
- >(
- keyPath: [K, K2, K3],
- notSetValue: NSV,
- updater: (value: $ValOf<$ValOf<V, K2>, K3> | NSV) => S
- ): this;
- updateIn<
- K2: $KeyOf<V>,
- K3: $KeyOf<$ValOf<V, K2>>,
- S: $ValOf<$ValOf<V, K2>, K3>
- >(
- keyPath: [K, K2, K3],
- updater: (value: $ValOf<$ValOf<V, K2>, K3>) => S
- ): this;
- updateIn<
- NSV,
- K2: $KeyOf<V>,
- K3: $KeyOf<$ValOf<V, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<V, K2>, K3>>,
- S: $ValOf<$ValOf<$ValOf<V, K2>, K3>, K4>
- >(
- keyPath: [K, K2, K3, K4],
- notSetValue: NSV,
- updater: (value: $ValOf<$ValOf<$ValOf<V, K2>, K3>, K4> | NSV) => S
- ): this;
- updateIn<
- K2: $KeyOf<V>,
- K3: $KeyOf<$ValOf<V, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<V, K2>, K3>>,
- S: $ValOf<$ValOf<$ValOf<V, K2>, K3>, K4>
- >(
- keyPath: [K, K2, K3, K4],
- updater: (value: $ValOf<$ValOf<$ValOf<V, K2>, K3>, K4>) => S
- ): this;
- updateIn<
- NSV,
- K2: $KeyOf<V>,
- K3: $KeyOf<$ValOf<V, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<V, K2>, K3>>,
- K5: $KeyOf<$ValOf<$ValOf<$ValOf<V, K2>, K3>, K4>>,
- S: $ValOf<$ValOf<$ValOf<$ValOf<V, K2>, K3>, K4>, K5>
- >(
- keyPath: [K, K2, K3, K4, K5],
- notSetValue: NSV,
- updater: (
- value: $ValOf<$ValOf<$ValOf<$ValOf<V, K2>, K3>, K4>, K5> | NSV
- ) => S
- ): this;
- updateIn<
- K2: $KeyOf<V>,
- K3: $KeyOf<$ValOf<V, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<V, K2>, K3>>,
- K5: $KeyOf<$ValOf<$ValOf<$ValOf<V, K2>, K3>, K4>>,
- S: $ValOf<$ValOf<$ValOf<$ValOf<V, K2>, K3>, K4>, K5>
- >(
- keyPath: [K, K2, K3, K4, K5],
- updater: (value: $ValOf<$ValOf<$ValOf<$ValOf<V, K2>, K3>, K4>, K5>) => S
- ): this;
- }
- declare function isList(maybeList: mixed): boolean %checks(maybeList instanceof
- List);
- declare class List<+T>
- extends IndexedCollection<T>
- mixins UpdatableInCollection<number, T>
- {
- static (collection?: Iterable<T>): List<T>;
- static of<T>(...values: T[]): List<T>;
- static isList: typeof isList;
- size: number;
- set<U>(index: number, value: U): List<T | U>;
- delete(index: number): this;
- remove(index: number): this;
- insert<U>(index: number, value: U): List<T | U>;
- clear(): this;
- push<U>(...values: U[]): List<T | U>;
- pop(): this;
- unshift<U>(...values: U[]): List<T | U>;
- shift(): this;
- update<U>(updater: (value: this) => U): U;
- update<U>(index: number, updater: (value: T) => U): List<T | U>;
- update<U>(
- index: number,
- notSetValue: U,
- updater: (value: T) => U
- ): List<T | U>;
- merge<U>(...collections: Iterable<U>[]): List<T | U>;
- setSize(size: number): this;
- mergeIn(keyPath: Iterable<mixed>, ...collections: Iterable<mixed>[]): this;
- mergeDeepIn(
- keyPath: Iterable<mixed>,
- ...collections: Iterable<mixed>[]
- ): this;
- withMutations(mutator: (mutable: this) => mixed): this;
- asMutable(): this;
- wasAltered(): boolean;
- asImmutable(): this;
- // Override specialized return types
- concat<C>(...iters: Array<Iterable<C> | C>): List<T | C>;
- filter(predicate: typeof Boolean): List<$NonMaybeType<T>>;
- filter(
- predicate: (value: T, index: number, iter: this) => mixed,
- context?: mixed
- ): List<T>;
- map<M>(
- mapper: (value: T, index: number, iter: this) => M,
- context?: mixed
- ): List<M>;
- flatMap<M>(
- mapper: (value: T, index: number, iter: this) => Iterable<M>,
- context?: mixed
- ): List<M>;
- flatten(depth?: number): List<any>;
- flatten(shallow?: boolean): List<any>;
- zip<A>(a: Iterable<A>, ..._: []): List<[T, A]>;
- zip<A, B>(a: Iterable<A>, b: Iterable<B>, ..._: []): List<[T, A, B]>;
- zip<A, B, C>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- ..._: []
- ): List<[T, A, B, C]>;
- zip<A, B, C, D>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- ..._: []
- ): List<[T, A, B, C, D]>;
- zip<A, B, C, D, E>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- e: Iterable<E>,
- ..._: []
- ): List<[T, A, B, C, D, E]>;
- zipAll<A>(a: Iterable<A>, ..._: []): List<[T | void, A | void]>;
- zipAll<A, B>(
- a: Iterable<A>,
- b: Iterable<B>,
- ..._: []
- ): List<[T | void, A | void, B | void]>;
- zipAll<A, B, C>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- ..._: []
- ): List<[T | void, A | void, B | void, C | void]>;
- zipAll<A, B, C, D>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- ..._: []
- ): List<[T | void, A | void, B | void, C | void, D | void]>;
- zipAll<A, B, C, D, E>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- e: Iterable<E>,
- ..._: []
- ): List<[T | void, A | void, B | void, C | void, D | void, E | void]>;
- zipWith<A, R>(
- zipper: (value: T, a: A) => R,
- a: Iterable<A>,
- ..._: []
- ): List<R>;
- zipWith<A, B, R>(
- zipper: (value: T, a: A, b: B) => R,
- a: Iterable<A>,
- b: Iterable<B>,
- ..._: []
- ): List<R>;
- zipWith<A, B, C, R>(
- zipper: (value: T, a: A, b: B, c: C) => R,
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- ..._: []
- ): List<R>;
- zipWith<A, B, C, D, R>(
- zipper: (value: T, a: A, b: B, c: C, d: D) => R,
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- ..._: []
- ): List<R>;
- zipWith<A, B, C, D, E, R>(
- zipper: (value: T, a: A, b: B, c: C, d: D, e: E) => R,
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- e: Iterable<E>,
- ..._: []
- ): List<R>;
- }
- declare function isMap(maybeMap: mixed): boolean %checks(maybeMap instanceof
- Map);
- declare class Map<K, +V>
- extends KeyedCollection<K, V>
- mixins UpdatableInCollection<K, V>
- {
- static <K, V>(values?: Iterable<[K, V]> | PlainObjInput<K, V>): Map<K, V>;
- static isMap: typeof isMap;
- size: number;
- set<K_, V_>(key: K_, value: V_): Map<K | K_, V | V_>;
- delete(key: K): this;
- remove(key: K): this;
- clear(): this;
- deleteAll(keys: Iterable<K>): Map<K, V>;
- removeAll(keys: Iterable<K>): Map<K, V>;
- update<U>(updater: (value: this) => U): U;
- update<V_>(key: K, updater: (value: V) => V_): Map<K, V | V_>;
- update<V_>(
- key: K,
- notSetValue: V_,
- updater: (value: V) => V_
- ): Map<K, V | V_>;
- merge<K_, V_>(
- ...collections: (Iterable<[K_, V_]> | PlainObjInput<K_, V_>)[]
- ): Map<K | K_, V | V_>;
- concat<K_, V_>(
- ...collections: (Iterable<[K_, V_]> | PlainObjInput<K_, V_>)[]
- ): Map<K | K_, V | V_>;
- mergeWith<K_, W, X>(
- merger: (oldVal: V, newVal: W, key: K) => X,
- ...collections: (Iterable<[K_, W]> | PlainObjInput<K_, W>)[]
- ): Map<K | K_, V | W | X>;
- mergeDeep<K_, V_>(
- ...collections: (Iterable<[K_, V_]> | PlainObjInput<K_, V_>)[]
- ): Map<K | K_, V | V_>;
- mergeDeepWith<K_, V_>(
- merger: (oldVal: any, newVal: any, key: any) => mixed,
- ...collections: (Iterable<[K_, V_]> | PlainObjInput<K_, V_>)[]
- ): Map<K | K_, V | V_>;
- mergeIn(
- keyPath: Iterable<mixed>,
- ...collections: (Iterable<mixed> | PlainObjInput<mixed, mixed>)[]
- ): this;
- mergeDeepIn(
- keyPath: Iterable<mixed>,
- ...collections: (Iterable<mixed> | PlainObjInput<mixed, mixed>)[]
- ): this;
- withMutations(mutator: (mutable: this) => mixed): this;
- asMutable(): this;
- wasAltered(): boolean;
- asImmutable(): this;
- // Override specialized return types
- flip(): Map<V, K>;
- filter(predicate: typeof Boolean): Map<K, $NonMaybeType<V>>;
- filter(
- predicate: (value: V, key: K, iter: this) => mixed,
- context?: mixed
- ): Map<K, V>;
- map<M>(
- mapper: (value: V, key: K, iter: this) => M,
- context?: mixed
- ): Map<K, M>;
- mapKeys<M>(
- mapper: (key: K, value: V, iter: this) => M,
- context?: mixed
- ): Map<M, V>;
- mapEntries<KM, VM>(
- mapper: (entry: [K, V], index: number, iter: this) => [KM, VM],
- context?: mixed
- ): Map<KM, VM>;
- flatMap<KM, VM>(
- mapper: (value: V, key: K, iter: this) => Iterable<[KM, VM]>,
- context?: mixed
- ): Map<KM, VM>;
- flatten(depth?: number): Map<any, any>;
- flatten(shallow?: boolean): Map<any, any>;
- }
- declare function isOrderedMap(
- maybeOrderedMap: mixed
- ): boolean %checks(maybeOrderedMap instanceof OrderedMap);
- declare class OrderedMap<K, +V>
- extends Map<K, V>
- mixins UpdatableInCollection<K, V>
- {
- static <K, V>(
- values?: Iterable<[K, V]> | PlainObjInput<K, V>
- ): OrderedMap<K, V>;
- static isOrderedMap: typeof isOrderedMap;
- size: number;
- set<K_, V_>(key: K_, value: V_): OrderedMap<K | K_, V | V_>;
- delete(key: K): this;
- remove(key: K): this;
- clear(): this;
- update<U>(updater: (value: this) => U): U;
- update<V_>(key: K, updater: (value: V) => V_): OrderedMap<K, V | V_>;
- update<V_>(
- key: K,
- notSetValue: V_,
- updater: (value: V) => V_
- ): OrderedMap<K, V | V_>;
- merge<K_, V_>(
- ...collections: (Iterable<[K_, V_]> | PlainObjInput<K_, V_>)[]
- ): OrderedMap<K | K_, V | V_>;
- concat<K_, V_>(
- ...collections: (Iterable<[K_, V_]> | PlainObjInput<K_, V_>)[]
- ): OrderedMap<K | K_, V | V_>;
- mergeWith<K_, W, X>(
- merger: (oldVal: V, newVal: W, key: K) => X,
- ...collections: (Iterable<[K_, W]> | PlainObjInput<K_, W>)[]
- ): OrderedMap<K | K_, V | W | X>;
- mergeDeep<K_, V_>(
- ...collections: (Iterable<[K_, V_]> | PlainObjInput<K_, V_>)[]
- ): OrderedMap<K | K_, V | V_>;
- mergeDeepWith<K_, V_>(
- merger: (oldVal: any, newVal: any, key: any) => mixed,
- ...collections: (Iterable<[K_, V_]> | PlainObjInput<K_, V_>)[]
- ): OrderedMap<K | K_, V | V_>;
- mergeIn(
- keyPath: Iterable<mixed>,
- ...collections: (Iterable<mixed> | PlainObjInput<mixed, mixed>)[]
- ): this;
- mergeDeepIn(
- keyPath: Iterable<mixed>,
- ...collections: (Iterable<mixed> | PlainObjInput<mixed, mixed>)[]
- ): this;
- withMutations(mutator: (mutable: this) => mixed): this;
- asMutable(): this;
- wasAltered(): boolean;
- asImmutable(): this;
- // Override specialized return types
- flip(): OrderedMap<V, K>;
- filter(predicate: typeof Boolean): OrderedMap<K, $NonMaybeType<V>>;
- filter(
- predicate: (value: V, key: K, iter: this) => mixed,
- context?: mixed
- ): OrderedMap<K, V>;
- map<M>(
- mapper: (value: V, key: K, iter: this) => M,
- context?: mixed
- ): OrderedMap<K, M>;
- mapKeys<M>(
- mapper: (key: K, value: V, iter: this) => M,
- context?: mixed
- ): OrderedMap<M, V>;
- mapEntries<KM, VM>(
- mapper: (entry: [K, V], index: number, iter: this) => [KM, VM],
- context?: mixed
- ): OrderedMap<KM, VM>;
- flatMap<KM, VM>(
- mapper: (value: V, key: K, iter: this) => Iterable<[KM, VM]>,
- context?: mixed
- ): OrderedMap<KM, VM>;
- flatten(depth?: number): OrderedMap<any, any>;
- flatten(shallow?: boolean): OrderedMap<any, any>;
- }
- declare function isSet(maybeSet: mixed): boolean %checks(maybeSet instanceof
- Set);
- declare class Set<+T> extends SetCollection<T> {
- static <T>(values?: Iterable<T>): Set<T>;
- static of<T>(...values: T[]): Set<T>;
- static fromKeys<T>(
- values: Iterable<[T, mixed]> | PlainObjInput<T, mixed>
- ): Set<T>;
- static intersect(sets: Iterable<Iterable<T>>): Set<T>;
- static union(sets: Iterable<Iterable<T>>): Set<T>;
- static isSet: typeof isSet;
- size: number;
- add<U>(value: U): Set<T | U>;
- delete(value: T): this;
- remove(value: T): this;
- clear(): this;
- union<U>(...collections: Iterable<U>[]): Set<T | U>;
- merge<U>(...collections: Iterable<U>[]): Set<T | U>;
- concat<U>(...collections: Iterable<U>[]): Set<T | U>;
- intersect<U>(...collections: Iterable<U>[]): Set<T & U>;
- subtract(...collections: Iterable<mixed>[]): this;
- withMutations(mutator: (mutable: this) => mixed): this;
- asMutable(): this;
- wasAltered(): boolean;
- asImmutable(): this;
- // Override specialized return types
- filter(predicate: typeof Boolean): Set<$NonMaybeType<T>>;
- filter(
- predicate: (value: T, value: T, iter: this) => mixed,
- context?: mixed
- ): Set<T>;
- map<M>(
- mapper: (value: T, value: T, iter: this) => M,
- context?: mixed
- ): Set<M>;
- flatMap<M>(
- mapper: (value: T, value: T, iter: this) => Iterable<M>,
- context?: mixed
- ): Set<M>;
- flatten(depth?: number): Set<any>;
- flatten(shallow?: boolean): Set<any>;
- }
- // Overrides except for `isOrderedSet` are for specialized return types
- declare function isOrderedSet(
- maybeOrderedSet: mixed
- ): boolean %checks(maybeOrderedSet instanceof OrderedSet);
- declare class OrderedSet<+T> extends Set<T> {
- static <T>(values?: Iterable<T>): OrderedSet<T>;
- static of<T>(...values: T[]): OrderedSet<T>;
- static fromKeys<T>(
- values: Iterable<[T, mixed]> | PlainObjInput<T, mixed>
- ): OrderedSet<T>;
- static isOrderedSet: typeof isOrderedSet;
- size: number;
- add<U>(value: U): OrderedSet<T | U>;
- union<U>(...collections: Iterable<U>[]): OrderedSet<T | U>;
- merge<U>(...collections: Iterable<U>[]): OrderedSet<T | U>;
- concat<U>(...collections: Iterable<U>[]): OrderedSet<T | U>;
- intersect<U>(...collections: Iterable<U>[]): OrderedSet<T & U>;
- filter(predicate: typeof Boolean): OrderedSet<$NonMaybeType<T>>;
- filter(
- predicate: (value: T, value: T, iter: this) => mixed,
- context?: mixed
- ): OrderedSet<T>;
- map<M>(
- mapper: (value: T, value: T, iter: this) => M,
- context?: mixed
- ): OrderedSet<M>;
- flatMap<M>(
- mapper: (value: T, value: T, iter: this) => Iterable<M>,
- context?: mixed
- ): OrderedSet<M>;
- flatten(depth?: number): OrderedSet<any>;
- flatten(shallow?: boolean): OrderedSet<any>;
- zip<A>(a: Iterable<A>, ..._: []): OrderedSet<[T, A]>;
- zip<A, B>(a: Iterable<A>, b: Iterable<B>, ..._: []): OrderedSet<[T, A, B]>;
- zip<A, B, C>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- ..._: []
- ): OrderedSet<[T, A, B, C]>;
- zip<A, B, C, D>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- ..._: []
- ): OrderedSet<[T, A, B, C, D]>;
- zip<A, B, C, D, E>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- e: Iterable<E>,
- ..._: []
- ): OrderedSet<[T, A, B, C, D, E]>;
- zipAll<A>(a: Iterable<A>, ..._: []): OrderedSet<[T | void, A | void]>;
- zipAll<A, B>(
- a: Iterable<A>,
- b: Iterable<B>,
- ..._: []
- ): OrderedSet<[T | void, A | void, B | void]>;
- zipAll<A, B, C>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- ..._: []
- ): OrderedSet<[T | void, A | void, B | void, C | void]>;
- zipAll<A, B, C, D>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- ..._: []
- ): OrderedSet<[T | void, A | void, B | void, C | void, D | void]>;
- zipAll<A, B, C, D, E>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- e: Iterable<E>,
- ..._: []
- ): OrderedSet<[T | void, A | void, B | void, C | void, D | void, E | void]>;
- zipWith<A, R>(
- zipper: (value: T, a: A) => R,
- a: Iterable<A>,
- ..._: []
- ): OrderedSet<R>;
- zipWith<A, B, R>(
- zipper: (value: T, a: A, b: B) => R,
- a: Iterable<A>,
- b: Iterable<B>,
- ..._: []
- ): OrderedSet<R>;
- zipWith<A, B, C, R>(
- zipper: (value: T, a: A, b: B, c: C) => R,
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- ..._: []
- ): OrderedSet<R>;
- zipWith<A, B, C, D, R>(
- zipper: (value: T, a: A, b: B, c: C, d: D) => R,
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- ..._: []
- ): OrderedSet<R>;
- zipWith<A, B, C, D, E, R>(
- zipper: (value: T, a: A, b: B, c: C, d: D, e: E) => R,
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- e: Iterable<E>,
- ..._: []
- ): OrderedSet<R>;
- }
- declare function isStack(
- maybeStack: mixed
- ): boolean %checks(maybeStack instanceof Stack);
- declare class Stack<+T> extends IndexedCollection<T> {
- static <T>(collection?: Iterable<T>): Stack<T>;
- static isStack(maybeStack: mixed): boolean;
- static of<T>(...values: T[]): Stack<T>;
- static isStack: typeof isStack;
- size: number;
- peek(): T;
- clear(): this;
- unshift<U>(...values: U[]): Stack<T | U>;
- unshiftAll<U>(iter: Iterable<U>): Stack<T | U>;
- shift(): this;
- push<U>(...values: U[]): Stack<T | U>;
- pushAll<U>(iter: Iterable<U>): Stack<T | U>;
- pop(): this;
- withMutations(mutator: (mutable: this) => mixed): this;
- asMutable(): this;
- wasAltered(): boolean;
- asImmutable(): this;
- // Override specialized return types
- concat<C>(...iters: Array<Iterable<C> | C>): Stack<T | C>;
- filter(predicate: typeof Boolean): Stack<$NonMaybeType<T>>;
- filter(
- predicate: (value: T, index: number, iter: this) => mixed,
- context?: mixed
- ): Stack<T>;
- map<M>(
- mapper: (value: T, index: number, iter: this) => M,
- context?: mixed
- ): Stack<M>;
- flatMap<M>(
- mapper: (value: T, index: number, iter: this) => Iterable<M>,
- context?: mixed
- ): Stack<M>;
- flatten(depth?: number): Stack<any>;
- flatten(shallow?: boolean): Stack<any>;
- zip<A>(a: Iterable<A>, ..._: []): Stack<[T, A]>;
- zip<A, B>(a: Iterable<A>, b: Iterable<B>, ..._: []): Stack<[T, A, B]>;
- zip<A, B, C>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- ..._: []
- ): Stack<[T, A, B, C]>;
- zip<A, B, C, D>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- ..._: []
- ): Stack<[T, A, B, C, D]>;
- zip<A, B, C, D, E>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- e: Iterable<E>,
- ..._: []
- ): Stack<[T, A, B, C, D, E]>;
- zipAll<A>(a: Iterable<A>, ..._: []): Stack<[T | void, A | void]>;
- zipAll<A, B>(
- a: Iterable<A>,
- b: Iterable<B>,
- ..._: []
- ): Stack<[T | void, A | void, B | void]>;
- zipAll<A, B, C>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- ..._: []
- ): Stack<[T | void, A | void, B | void, C | void]>;
- zipAll<A, B, C, D>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- ..._: []
- ): Stack<[T | void, A | void, B | void, C | void, D | void]>;
- zipAll<A, B, C, D, E>(
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- e: Iterable<E>,
- ..._: []
- ): Stack<[T | void, A | void, B | void, C | void, D | void, E | void]>;
- zipWith<A, R>(
- zipper: (value: T, a: A) => R,
- a: Iterable<A>,
- ..._: []
- ): Stack<R>;
- zipWith<A, B, R>(
- zipper: (value: T, a: A, b: B) => R,
- a: Iterable<A>,
- b: Iterable<B>,
- ..._: []
- ): Stack<R>;
- zipWith<A, B, C, R>(
- zipper: (value: T, a: A, b: B, c: C) => R,
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- ..._: []
- ): Stack<R>;
- zipWith<A, B, C, D, R>(
- zipper: (value: T, a: A, b: B, c: C, d: D) => R,
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- ..._: []
- ): Stack<R>;
- zipWith<A, B, C, D, E, R>(
- zipper: (value: T, a: A, b: B, c: C, d: D, e: E) => R,
- a: Iterable<A>,
- b: Iterable<B>,
- c: Iterable<C>,
- d: Iterable<D>,
- e: Iterable<E>,
- ..._: []
- ): Stack<R>;
- }
- declare function Range(
- start?: number,
- end?: number,
- step?: number
- ): IndexedSeq<number>;
- declare function Repeat<T>(value: T, times?: number): IndexedSeq<T>;
- // The type of a Record factory function.
- type RecordFactory<Values: Object> = Class<RecordInstance<Values>>;
- // The type of runtime Record instances.
- type RecordOf<Values: Object> = RecordInstance<Values> & $ReadOnly<Values>;
- // The values of a Record instance.
- type _RecordValues<T, R: RecordInstance<T> | T> = R;
- type RecordValues<R> = _RecordValues<*, R>;
- declare function isRecord(
- maybeRecord: any
- ): boolean %checks(maybeRecord instanceof RecordInstance);
- declare class Record {
- static <Values: Object>(spec: Values, name?: string): typeof RecordInstance;
- constructor<Values: Object>(
- spec: Values,
- name?: string
- ): typeof RecordInstance;
- static isRecord: typeof isRecord;
- static getDescriptiveName(record: RecordInstance<any>): string;
- }
- declare class RecordInstance<T: Object = Object> {
- static (values?: Iterable<[$Keys<T>, $ValOf<T>]> | $Shape<T>): RecordOf<T>;
- // Note: a constructor can only create an instance of RecordInstance<T>,
- // it's encouraged to not use `new` when creating Records.
- constructor(values?: Iterable<[$Keys<T>, $ValOf<T>]> | $Shape<T>): void;
- size: number;
- has(key: string): boolean;
- get<K: $Keys<T>>(key: K, ..._: []): $ElementType<T, K>;
- get<K: $Keys<T>, NSV>(key: K, notSetValue: NSV): $ElementType<T, K> | NSV;
- hasIn(keyPath: Iterable<mixed>): boolean;
- getIn(keyPath: [], notSetValue?: mixed): this & $ReadOnly<T>;
- getIn<K: $Keys<T>>(keyPath: [K], notSetValue?: mixed): $ElementType<T, K>;
- getIn<NSV, K: $Keys<T>, K2: $KeyOf<$ValOf<T, K>>>(
- keyPath: [K, K2],
- notSetValue: NSV
- ): $ValOf<$ValOf<T, K>, K2> | NSV;
- getIn<
- NSV,
- K: $Keys<T>,
- K2: $KeyOf<$ValOf<T, K>>,
- K3: $KeyOf<$ValOf<$ValOf<T, K>, K2>>
- >(
- keyPath: [K, K2, K3],
- notSetValue: NSV
- ): $ValOf<$ValOf<$ValOf<T, K>, K2>, K3> | NSV;
- getIn<
- NSV,
- K: $Keys<T>,
- K2: $KeyOf<$ValOf<T, K>>,
- K3: $KeyOf<$ValOf<$ValOf<T, K>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>>
- >(
- keyPath: [K, K2, K3, K4],
- notSetValue: NSV
- ): $ValOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>, K4> | NSV;
- getIn<
- NSV,
- K: $Keys<T>,
- K2: $KeyOf<$ValOf<T, K>>,
- K3: $KeyOf<$ValOf<$ValOf<T, K>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>>,
- K5: $KeyOf<$ValOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>, K4>>
- >(
- keyPath: [K, K2, K3, K4, K5],
- notSetValue: NSV
- ): $ValOf<$ValOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>, K4>, K5> | NSV;
- equals(other: any): boolean;
- hashCode(): number;
- set<K: $Keys<T>>(key: K, value: $ElementType<T, K>): this & $ReadOnly<T>;
- update<K: $Keys<T>>(
- key: K,
- updater: (value: $ElementType<T, K>) => $ElementType<T, K>
- ): this & $ReadOnly<T>;
- merge(
- ...collections: Array<Iterable<[$Keys<T>, $ValOf<T>]> | $Shape<T>>
- ): this & $ReadOnly<T>;
- mergeDeep(
- ...collections: Array<Iterable<[$Keys<T>, $ValOf<T>]> | $Shape<T>>
- ): this & $ReadOnly<T>;
- mergeWith(
- merger: (oldVal: $ValOf<T>, newVal: $ValOf<T>, key: $Keys<T>) => $ValOf<T>,
- ...collections: Array<Iterable<[$Keys<T>, $ValOf<T>]> | $Shape<T>>
- ): this & $ReadOnly<T>;
- mergeDeepWith(
- merger: (oldVal: any, newVal: any, key: any) => any,
- ...collections: Array<Iterable<[$Keys<T>, $ValOf<T>]> | $Shape<T>>
- ): this & $ReadOnly<T>;
- delete<K: $Keys<T>>(key: K): this & $ReadOnly<T>;
- remove<K: $Keys<T>>(key: K): this & $ReadOnly<T>;
- clear(): this & $ReadOnly<T>;
- setIn<S>(keyPath: [], value: S): S;
- setIn<K: $Keys<T>, S: $ValOf<T, K>>(
- keyPath: [K],
- value: S
- ): this & $ReadOnly<T>;
- setIn<K: $Keys<T>, K2: $KeyOf<$ValOf<T, K>>, S: $ValOf<$ValOf<T, K>, K2>>(
- keyPath: [K, K2],
- value: S
- ): this & $ReadOnly<T>;
- setIn<
- K: $Keys<T>,
- K2: $KeyOf<$ValOf<T, K>>,
- K3: $KeyOf<$ValOf<$ValOf<T, K>, K2>>,
- S: $ValOf<$ValOf<$ValOf<T, K>, K2>, K3>
- >(
- keyPath: [K, K2, K3],
- value: S
- ): this & $ReadOnly<T>;
- setIn<
- K: $Keys<T>,
- K2: $KeyOf<$ValOf<T, K>>,
- K3: $KeyOf<$ValOf<$ValOf<T, K>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>>,
- S: $ValOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>, K4>
- >(
- keyPath: [K, K2, K3, K4],
- value: S
- ): this & $ReadOnly<T>;
- setIn<
- K: $Keys<T>,
- K2: $KeyOf<$ValOf<T, K>>,
- K3: $KeyOf<$ValOf<$ValOf<T, K>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>>,
- K5: $KeyOf<$ValOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>, K4>>,
- S: $ValOf<$ValOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>, K4>, K5>
- >(
- keyPath: [K, K2, K3, K4, K5],
- value: S
- ): this & $ReadOnly<T>;
- deleteIn(keyPath: []): void;
- deleteIn<K: $Keys<T>>(keyPath: [K]): this & $ReadOnly<T>;
- deleteIn<K: $Keys<T>, K2: $KeyOf<$ValOf<T, K>>>(
- keyPath: [K, K2]
- ): this & $ReadOnly<T>;
- deleteIn<
- K: $Keys<T>,
- K2: $KeyOf<$ValOf<T, K>>,
- K3: $KeyOf<$ValOf<$ValOf<T, K>, K2>>
- >(
- keyPath: [K, K2, K3]
- ): this & $ReadOnly<T>;
- deleteIn<
- K: $Keys<T>,
- K2: $KeyOf<$ValOf<T, K>>,
- K3: $KeyOf<$ValOf<$ValOf<T, K>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>>
- >(
- keyPath: [K, K2, K3, K4]
- ): this & $ReadOnly<T>;
- deleteIn<
- K: $Keys<T>,
- K2: $KeyOf<$ValOf<T, K>>,
- K3: $KeyOf<$ValOf<$ValOf<T, K>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>>,
- K5: $KeyOf<$ValOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>, K4>>
- >(
- keyPath: [K, K2, K3, K4, K5]
- ): this & $ReadOnly<T>;
- removeIn(keyPath: []): void;
- removeIn<K: $Keys<T>>(keyPath: [K]): this & $ReadOnly<T>;
- removeIn<K: $Keys<T>, K2: $KeyOf<$ValOf<T, K>>>(
- keyPath: [K, K2]
- ): this & $ReadOnly<T>;
- removeIn<
- K: $Keys<T>,
- K2: $KeyOf<$ValOf<T, K>>,
- K3: $KeyOf<$ValOf<$ValOf<T, K>, K2>>
- >(
- keyPath: [K, K2, K3]
- ): this & $ReadOnly<T>;
- removeIn<
- K: $Keys<T>,
- K2: $KeyOf<$ValOf<T, K>>,
- K3: $KeyOf<$ValOf<$ValOf<T, K>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>>
- >(
- keyPath: [K, K2, K3, K4]
- ): this & $ReadOnly<T>;
- removeIn<
- K: $Keys<T>,
- K2: $KeyOf<$ValOf<T, K>>,
- K3: $KeyOf<$ValOf<$ValOf<T, K>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>>,
- K5: $KeyOf<$ValOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>, K4>>
- >(
- keyPath: [K, K2, K3, K4, K5]
- ): this & $ReadOnly<T>;
- updateIn<U>(
- keyPath: [],
- notSetValue: mixed,
- updater: (value: this & T) => U
- ): U;
- updateIn<U>(keyPath: [], updater: (value: this & T) => U): U;
- updateIn<NSV, K: $Keys<T>, S: $ValOf<T, K>>(
- keyPath: [K],
- notSetValue: NSV,
- updater: (value: $ValOf<T, K>) => S
- ): this & $ReadOnly<T>;
- updateIn<K: $Keys<T>, S: $ValOf<T, K>>(
- keyPath: [K],
- updater: (value: $ValOf<T, K>) => S
- ): this & $ReadOnly<T>;
- updateIn<
- NSV,
- K: $Keys<T>,
- K2: $KeyOf<$ValOf<T, K>>,
- S: $ValOf<$ValOf<T, K>, K2>
- >(
- keyPath: [K, K2],
- notSetValue: NSV,
- updater: (value: $ValOf<$ValOf<T, K>, K2> | NSV) => S
- ): this & $ReadOnly<T>;
- updateIn<K: $Keys<T>, K2: $KeyOf<$ValOf<T, K>>, S: $ValOf<$ValOf<T, K>, K2>>(
- keyPath: [K, K2],
- updater: (value: $ValOf<$ValOf<T, K>, K2>) => S
- ): this & $ReadOnly<T>;
- updateIn<
- NSV,
- K: $Keys<T>,
- K2: $KeyOf<$ValOf<T, K>>,
- K3: $KeyOf<$ValOf<$ValOf<T, K>, K2>>,
- S: $ValOf<$ValOf<$ValOf<T, K>, K2>, K3>
- >(
- keyPath: [K, K2, K3],
- notSetValue: NSV,
- updater: (value: $ValOf<$ValOf<$ValOf<T, K>, K2>, K3> | NSV) => S
- ): this & $ReadOnly<T>;
- updateIn<
- K: $Keys<T>,
- K2: $KeyOf<$ValOf<T, K>>,
- K3: $KeyOf<$ValOf<$ValOf<T, K>, K2>>,
- S: $ValOf<$ValOf<$ValOf<T, K>, K2>, K3>
- >(
- keyPath: [K, K2, K3],
- updater: (value: $ValOf<$ValOf<$ValOf<T, K>, K2>, K3>) => S
- ): this & $ReadOnly<T>;
- updateIn<
- NSV,
- K: $Keys<T>,
- K2: $KeyOf<$ValOf<T, K>>,
- K3: $KeyOf<$ValOf<$ValOf<T, K>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>>,
- S: $ValOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>, K4>
- >(
- keyPath: [K, K2, K3, K4],
- notSetValue: NSV,
- updater: (
- value: $ValOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>, K4> | NSV
- ) => S
- ): this & $ReadOnly<T>;
- updateIn<
- K: $Keys<T>,
- K2: $KeyOf<$ValOf<T, K>>,
- K3: $KeyOf<$ValOf<$ValOf<T, K>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>>,
- S: $ValOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>, K4>
- >(
- keyPath: [K, K2, K3, K4],
- updater: (value: $ValOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>, K4>) => S
- ): this & $ReadOnly<T>;
- updateIn<
- NSV,
- K: $Keys<T>,
- K2: $KeyOf<$ValOf<T, K>>,
- K3: $KeyOf<$ValOf<$ValOf<T, K>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>>,
- K5: $KeyOf<$ValOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>, K4>>,
- S: $ValOf<$ValOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>, K4>, K5>
- >(
- keyPath: [K, K2, K3, K4, K5],
- notSetValue: NSV,
- updater: (
- value: $ValOf<$ValOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>, K4>, K5> | NSV
- ) => S
- ): this & $ReadOnly<T>;
- updateIn<
- K: $Keys<T>,
- K2: $KeyOf<$ValOf<T, K>>,
- K3: $KeyOf<$ValOf<$ValOf<T, K>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>>,
- K5: $KeyOf<$ValOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>, K4>>,
- S: $ValOf<$ValOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>, K4>, K5>
- >(
- keyPath: [K, K2, K3, K4, K5],
- updater: (
- value: $ValOf<$ValOf<$ValOf<$ValOf<$ValOf<T, K>, K2>, K3>, K4>, K5>
- ) => S
- ): this & $ReadOnly<T>;
- mergeIn(
- keyPath: Iterable<mixed>,
- ...collections: Array<any>
- ): this & $ReadOnly<T>;
- mergeDeepIn(
- keyPath: Iterable<mixed>,
- ...collections: Array<any>
- ): this & $ReadOnly<T>;
- toSeq(): KeyedSeq<$Keys<T>, any>;
- toJS(): { [key: $Keys<T>]: mixed };
- toJSON(): T;
- toObject(): T;
- withMutations(mutator: (mutable: this & T) => mixed): this & $ReadOnly<T>;
- asMutable(): this & $ReadOnly<T>;
- wasAltered(): boolean;
- asImmutable(): this & $ReadOnly<T>;
- @@iterator(): Iterator<[$Keys<T>, $ValOf<T>]>;
- }
- declare function fromJS(
- jsValue: mixed,
- reviver?: (
- key: string | number,
- sequence: KeyedCollection<string, mixed> | IndexedCollection<mixed>,
- path?: Array<string | number>
- ) => mixed
- ): Collection<mixed, mixed>;
- declare function is(first: mixed, second: mixed): boolean;
- declare function hash(value: mixed): number;
- declare function get<C: Object, K: $Keys<C>>(
- collection: C,
- key: K,
- notSetValue: mixed
- ): $ValOf<C, K>;
- declare function get<C, K: $KeyOf<C>, NSV>(
- collection: C,
- key: K,
- notSetValue: NSV
- ): $ValOf<C, K> | NSV;
- declare function has(collection: Object, key: mixed): boolean;
- declare function remove<C>(collection: C, key: $KeyOf<C>): C;
- declare function set<C, K: $KeyOf<C>, V: $ValOf<C, K>>(
- collection: C,
- key: K,
- value: V
- ): C;
- declare function update<C, K: $KeyOf<C>, V: $ValOf<C, K>, NSV>(
- collection: C,
- key: K,
- notSetValue: NSV,
- updater: ($ValOf<C, K> | NSV) => V
- ): C;
- declare function update<C, K: $KeyOf<C>, V: $ValOf<C, K>>(
- collection: C,
- key: K,
- updater: ($ValOf<C, K>) => V
- ): C;
- declare function getIn<C>(collection: C, keyPath: [], notSetValue?: mixed): C;
- declare function getIn<C, K: $KeyOf<C>, NSV>(
- collection: C,
- keyPath: [K],
- notSetValue: NSV
- ): $ValOf<C, K> | NSV;
- declare function getIn<C, K: $KeyOf<C>, K2: $KeyOf<$ValOf<C, K>>, NSV>(
- collection: C,
- keyPath: [K, K2],
- notSetValue: NSV
- ): $ValOf<$ValOf<C, K>, K2> | NSV;
- declare function getIn<
- C,
- K: $KeyOf<C>,
- K2: $KeyOf<$ValOf<C, K>>,
- K3: $KeyOf<$ValOf<$ValOf<C, K>, K2>>,
- NSV
- >(
- collection: C,
- keyPath: [K, K2, K3],
- notSetValue: NSV
- ): $ValOf<$ValOf<$ValOf<C, K>, K2>, K3> | NSV;
- declare function getIn<
- C,
- K: $KeyOf<C>,
- K2: $KeyOf<$ValOf<C, K>>,
- K3: $KeyOf<$ValOf<$ValOf<C, K>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>>,
- NSV
- >(
- collection: C,
- keyPath: [K, K2, K3, K4],
- notSetValue: NSV
- ): $ValOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>, K4> | NSV;
- declare function getIn<
- C,
- K: $KeyOf<C>,
- K2: $KeyOf<$ValOf<C, K>>,
- K3: $KeyOf<$ValOf<$ValOf<C, K>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>>,
- K5: $KeyOf<$ValOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>, K4>>,
- NSV
- >(
- collection: C,
- keyPath: [K, K2, K3, K4, K5],
- notSetValue: NSV
- ): $ValOf<$ValOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>, K4>, K5> | NSV;
- declare function hasIn(collection: Object, keyPath: Iterable<mixed>): boolean;
- declare function removeIn<C>(collection: C, keyPath: []): void;
- declare function removeIn<C, K: $KeyOf<C>>(collection: C, keyPath: [K]): C;
- declare function removeIn<C, K: $KeyOf<C>, K2: $KeyOf<$ValOf<C>>>(
- collection: C,
- keyPath: [K, K2]
- ): C;
- declare function removeIn<
- C,
- K: $KeyOf<C>,
- K2: $KeyOf<$ValOf<C>>,
- K3: $KeyOf<$ValOf<$ValOf<C>, K2>>
- >(
- collection: C,
- keyPath: [K, K2, K3]
- ): C;
- declare function removeIn<
- C,
- K: $KeyOf<C>,
- K2: $KeyOf<$ValOf<C>>,
- K3: $KeyOf<$ValOf<$ValOf<C>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<C>, K2>, K3>>
- >(
- collection: C,
- keyPath: [K, K2, K3, K4]
- ): C;
- declare function removeIn<
- C,
- K: $KeyOf<C>,
- K2: $KeyOf<$ValOf<C>>,
- K3: $KeyOf<$ValOf<$ValOf<C>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<C>, K2>, K3>>,
- K5: $KeyOf<$ValOf<$ValOf<$ValOf<$ValOf<C>, K2>, K3>, K4>>
- >(
- collection: C,
- keyPath: [K, K2, K3, K4, K5]
- ): C;
- declare function setIn<S>(collection: Object, keyPath: [], value: S): S;
- declare function setIn<C, K: $KeyOf<C>, S: $ValOf<C, K>>(
- collection: C,
- keyPath: [K],
- value: S
- ): C;
- declare function setIn<
- C,
- K: $KeyOf<C>,
- K2: $KeyOf<$ValOf<C, K>>,
- S: $ValOf<$ValOf<C, K>, K2>
- >(
- collection: C,
- keyPath: [K, K2],
- value: S
- ): C;
- declare function setIn<
- C,
- K: $KeyOf<C>,
- K2: $KeyOf<$ValOf<C, K>>,
- K3: $KeyOf<$ValOf<$ValOf<C, K>, K2>>,
- S: $ValOf<$ValOf<$ValOf<C, K>, K2>, K3>
- >(
- collection: C,
- keyPath: [K, K2, K3],
- value: S
- ): C;
- declare function setIn<
- C,
- K: $KeyOf<C>,
- K2: $KeyOf<$ValOf<C, K>>,
- K3: $KeyOf<$ValOf<$ValOf<C, K>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>>,
- S: $ValOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>, K4>
- >(
- collection: C,
- keyPath: [K, K2, K3, K4],
- value: S
- ): C;
- declare function setIn<
- C,
- K: $KeyOf<C>,
- K2: $KeyOf<$ValOf<C, K>>,
- K3: $KeyOf<$ValOf<$ValOf<C, K>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>>,
- K5: $KeyOf<$ValOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>, K4>>,
- S: $ValOf<$ValOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>, K4>, K5>
- >(
- collection: C,
- keyPath: [K, K2, K3, K4, K5],
- value: S
- ): C;
- declare function updateIn<C, S>(
- collection: C,
- keyPath: [],
- notSetValue: mixed,
- updater: (value: C) => S
- ): S;
- declare function updateIn<C, S>(
- collection: C,
- keyPath: [],
- updater: (value: C) => S
- ): S;
- declare function updateIn<C, K: $KeyOf<C>, S: $ValOf<C, K>, NSV>(
- collection: C,
- keyPath: [K],
- notSetValue: NSV,
- updater: (value: $ValOf<C, K> | NSV) => S
- ): C;
- declare function updateIn<C, K: $KeyOf<C>, S: $ValOf<C, K>>(
- collection: C,
- keyPath: [K],
- updater: (value: $ValOf<C, K>) => S
- ): C;
- declare function updateIn<
- C,
- K: $KeyOf<C>,
- K2: $KeyOf<$ValOf<C, K>>,
- S: $ValOf<$ValOf<C, K>, K2>,
- NSV
- >(
- collection: C,
- keyPath: [K, K2],
- notSetValue: NSV,
- updater: (value: $ValOf<$ValOf<C, K>, K2> | NSV) => S
- ): C;
- declare function updateIn<
- C,
- K: $KeyOf<C>,
- K2: $KeyOf<$ValOf<C, K>>,
- S: $ValOf<$ValOf<C, K>, K2>
- >(
- collection: C,
- keyPath: [K, K2],
- updater: (value: $ValOf<$ValOf<C, K>, K2>) => S
- ): C;
- declare function updateIn<
- C,
- K: $KeyOf<C>,
- K2: $KeyOf<$ValOf<C, K>>,
- K3: $KeyOf<$ValOf<$ValOf<C, K>, K2>>,
- S: $ValOf<$ValOf<$ValOf<C, K>, K2>, K3>,
- NSV
- >(
- collection: C,
- keyPath: [K, K2, K3],
- notSetValue: NSV,
- updater: (value: $ValOf<$ValOf<$ValOf<C, K>, K2>, K3> | NSV) => S
- ): C;
- declare function updateIn<
- C,
- K: $KeyOf<C>,
- K2: $KeyOf<$ValOf<C, K>>,
- K3: $KeyOf<$ValOf<$ValOf<C, K>, K2>>,
- S: $ValOf<$ValOf<$ValOf<C, K>, K2>, K3>
- >(
- collection: C,
- keyPath: [K, K2, K3],
- updater: (value: $ValOf<$ValOf<$ValOf<C, K>, K2>, K3>) => S
- ): C;
- declare function updateIn<
- C,
- K: $KeyOf<C>,
- K2: $KeyOf<$ValOf<C, K>>,
- K3: $KeyOf<$ValOf<$ValOf<C, K>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>>,
- S: $ValOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>, K4>,
- NSV
- >(
- collection: C,
- keyPath: [K, K2, K3, K4],
- notSetValue: NSV,
- updater: (value: $ValOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>, K4> | NSV) => S
- ): C;
- declare function updateIn<
- C,
- K: $KeyOf<C>,
- K2: $KeyOf<$ValOf<C, K>>,
- K3: $KeyOf<$ValOf<$ValOf<C, K>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>>,
- S: $ValOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>, K4>
- >(
- collection: C,
- keyPath: [K, K2, K3, K4],
- updater: (value: $ValOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>, K4>) => S
- ): C;
- declare function updateIn<
- C,
- K: $KeyOf<C>,
- K2: $KeyOf<$ValOf<C, K>>,
- K3: $KeyOf<$ValOf<$ValOf<C, K>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>>,
- K5: $KeyOf<$ValOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>, K4>>,
- S: $ValOf<$ValOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>, K4>, K5>,
- NSV
- >(
- collection: C,
- keyPath: [K, K2, K3, K4, K5],
- notSetValue: NSV,
- updater: (
- value: $ValOf<$ValOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>, K4>, K5> | NSV
- ) => S
- ): C;
- declare function updateIn<
- C,
- K: $KeyOf<C>,
- K2: $KeyOf<$ValOf<C, K>>,
- K3: $KeyOf<$ValOf<$ValOf<C, K>, K2>>,
- K4: $KeyOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>>,
- K5: $KeyOf<$ValOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>, K4>>,
- S: $ValOf<$ValOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>, K4>, K5>
- >(
- collection: C,
- keyPath: [K, K2, K3, K4, K5],
- updater: (
- value: $ValOf<$ValOf<$ValOf<$ValOf<$ValOf<C, K>, K2>, K3>, K4>, K5>
- ) => S
- ): C;
- declare function merge<C>(
- collection: C,
- ...collections: Array<
- | $IterableOf<C>
- | $Shape<RecordValues<C>>
- | PlainObjInput<$KeyOf<C>, $ValOf<C>>
- >
- ): C;
- declare function mergeWith<C>(
- merger: (oldVal: $ValOf<C>, newVal: $ValOf<C>, key: $KeyOf<C>) => $ValOf<C>,
- collection: C,
- ...collections: Array<
- | $IterableOf<C>
- | $Shape<RecordValues<C>>
- | PlainObjInput<$KeyOf<C>, $ValOf<C>>
- >
- ): C;
- declare function mergeDeep<C>(
- collection: C,
- ...collections: Array<
- | $IterableOf<C>
- | $Shape<RecordValues<C>>
- | PlainObjInput<$KeyOf<C>, $ValOf<C>>
- >
- ): C;
- declare function mergeDeepWith<C>(
- merger: (oldVal: any, newVal: any, key: any) => mixed,
- collection: C,
- ...collections: Array<
- | $IterableOf<C>
- | $Shape<RecordValues<C>>
- | PlainObjInput<$KeyOf<C>, $ValOf<C>>
- >
- ): C;
- export {
- Collection,
- Seq,
- List,
- Map,
- OrderedMap,
- OrderedSet,
- Range,
- Repeat,
- Record,
- Set,
- Stack,
- fromJS,
- is,
- hash,
- isImmutable,
- isCollection,
- isKeyed,
- isIndexed,
- isAssociative,
- isOrdered,
- isRecord,
- isValueObject,
- get,
- has,
- remove,
- set,
- update,
- getIn,
- hasIn,
- removeIn,
- setIn,
- updateIn,
- merge,
- mergeWith,
- mergeDeep,
- mergeDeepWith,
- };
- export default {
- Collection,
- Seq,
- List,
- Map,
- OrderedMap,
- OrderedSet,
- Range,
- Repeat,
- Record,
- Set,
- Stack,
- fromJS,
- is,
- hash,
- isImmutable,
- isCollection,
- isKeyed,
- isIndexed,
- isAssociative,
- isOrdered,
- isRecord,
- isValueObject,
- get,
- has,
- remove,
- set,
- update,
- getIn,
- hasIn,
- removeIn,
- setIn,
- updateIn,
- merge,
- mergeWith,
- mergeDeep,
- mergeDeepWith,
- };
- export type {
- KeyedCollection,
- IndexedCollection,
- SetCollection,
- KeyedSeq,
- IndexedSeq,
- SetSeq,
- RecordFactory,
- RecordOf,
- RecordInstance,
- ValueObject,
- $KeyOf,
- $ValOf,
- };
|