-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #676 from mobxjs/flow
generate flow types
- Loading branch information
Showing
6 changed files
with
442 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
[ignore] | ||
.*/node_modules | ||
|
||
[include] | ||
test/flow | ||
|
||
[libs] | ||
flow-typed/ | ||
|
||
[options] | ||
suppress_comment= \\(.\\|\n\\)*\\$ExpectError |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -11,3 +11,4 @@ test/typescript-tests.js* | |
dist/ | ||
.build/ | ||
yarn.lock | ||
.idea |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,359 @@ | ||
declare module 'mobx' { | ||
declare type extras = { | ||
allowStateChanges: <T>(allowStateChanges: boolean, func: () => T) => T, | ||
getAtom: (thing: any, property?: string) => IDepTreeNode, | ||
getDebugName: (thing: any, property?: string) => string, | ||
getDependencyTree: (thing: any, property?: string) => IDependencyTree, | ||
getGlobalState: () => any; | ||
getObserverTree: (thing: any, property?: string) => IObserverTree, | ||
isComputingDerivation: () => boolean, | ||
isSpyEnabled: () => boolean, | ||
resetGlobalState: () => void, | ||
shareGlobalState: () => void; | ||
spyReport: (event: any) => boolean, | ||
spyReportEnd: (change?: any) => void, | ||
spyReportStart: (event: any) => void, | ||
setReactionScheduler: (fn: (f: () => void) => void) => void | ||
}; | ||
|
||
declare interface IInterceptable<T> { | ||
interceptors: IInterceptor<T>[] | any, | ||
intercept(handler: IInterceptor<T>): Lambda | ||
} | ||
|
||
declare type _ = { | ||
getAdministration: (thing: any, property?: string) => any, | ||
resetGlobalState: () => void | ||
}; | ||
|
||
declare type ITransformer<A, B> = (object: A) => B; | ||
|
||
declare type IInterceptor<T> = (change: T) => T; | ||
|
||
declare type IMapEntry<V> = [string, V]; | ||
|
||
declare type IMapEntries<V> = IMapEntry<V>[]; | ||
|
||
declare type isObservableMap = (x: any) => boolean; | ||
|
||
declare type ISimpleEventListener = { | ||
(): void | ||
}; | ||
|
||
declare interface IComputedValueOptions { | ||
asStructure: boolean | ||
} | ||
|
||
declare interface IDependencyTree { | ||
name: string, | ||
dependencies?: IDependencyTree[] | ||
} | ||
|
||
declare interface IObserverTree { | ||
name: string, | ||
observers?: IObserverTree[] | ||
} | ||
|
||
declare interface IAtom { | ||
|
||
} | ||
|
||
declare type IDerivationState = 'NOT_TRACKING' | 'UP_TO_DATE' | 'POSSIBLY_STALE' | 'STALE' | ||
declare type PropertyDescriptor = any | ||
|
||
declare interface IComputedValue<T> { | ||
get(): T, | ||
set(value: T): void, | ||
observe( | ||
listener: (newValue: T, oldValue: T) => void, fireImmediately?: boolean | ||
): Lambda | ||
} | ||
|
||
declare interface IObservable { | ||
diffValue: number, | ||
lastAccessedBy: number, | ||
lowestObserverState: IDerivationState, | ||
isPendingUnobservation: boolean, | ||
observers: IDerivation[], | ||
observersIndexes: { | ||
|
||
}, | ||
onBecomeUnobserved(): any | ||
} | ||
|
||
declare interface IDepTreeNode { | ||
name: string, | ||
observing?: IObservable[] | ||
} | ||
|
||
declare interface IDerivation { | ||
name: string, | ||
observing: IObservable[], | ||
newObserving: ?IObservable[], | ||
dependenciesState: IDerivationState, | ||
runId: number, | ||
unboundDepsCount: number, | ||
___mapid: string, | ||
onBecomeStale(): any, | ||
recoverFromError(): any | ||
} | ||
|
||
declare interface IReactionPublic { | ||
dispose: () => void | ||
} | ||
|
||
declare interface IListenable { | ||
changeListeners: any, | ||
observe( | ||
handler: (change: any, oldValue?: any) => void, fireImmediately?: boolean | ||
): Lambda | ||
} | ||
|
||
declare interface IObservableArray<T> extends Array<T> { | ||
spliceWithArray(index: number, deleteCount?: number, newItems?: T[]): T[], | ||
observe( | ||
listener: (changeData: IArrayChange<T> | IArraySplice<T>) => void, fireImmediately?: boolean | ||
): Lambda, | ||
intercept<T>(handler: IInterceptor<IArrayChange<T> | IArraySplice<T>>): Lambda, | ||
clear(): T[], | ||
peek(): T[], | ||
replace(newItems: T[]): T[], | ||
find( | ||
predicate: (item: T, index: number, array: Array<T>) => boolean, thisArg?: any, fromIndex?: number | ||
): T | any, | ||
remove(value: T): boolean | ||
} | ||
|
||
declare interface IArrayChange<T> { | ||
type: 'update', | ||
object: IObservableArray<T>, | ||
index: number, | ||
newValue: T, | ||
oldValue: T | ||
} | ||
|
||
declare interface IArraySplice<T> { | ||
type: 'splice', | ||
object: IObservableArray<T>, | ||
index: number, | ||
added: T[], | ||
addedCount: number, | ||
removed: T[], | ||
removedCount: number | ||
} | ||
|
||
declare interface IArrayWillChange<T> { | ||
type: 'update', | ||
object: IObservableArray<T>, | ||
index: number, | ||
newValue: T | ||
} | ||
|
||
declare interface IArrayWillSplice<T> { | ||
type: 'splice', | ||
object: IObservableArray<T>, | ||
index: number, | ||
added: T[], | ||
removedCount: number | ||
} | ||
|
||
declare interface IKeyValueMap<V> { | ||
[key: string]: V | ||
} | ||
|
||
declare interface IMapChange<T> { | ||
object: ObservableMap<T>, | ||
type: 'update' | 'add' | 'delete', | ||
name: string, | ||
newValue?: any, | ||
oldValue?: any | ||
} | ||
|
||
declare interface IMapWillChange<T> { | ||
object: ObservableMap<T>, | ||
type: 'update' | 'add' | 'delete', | ||
name: string, | ||
newValue?: any | ||
} | ||
|
||
declare interface IObservableObject {} | ||
|
||
declare interface IObjectChange { | ||
name: string, | ||
object: any, | ||
type: 'update' | 'add', | ||
oldValue?: any, | ||
newValue: any | ||
} | ||
|
||
declare interface IObjectWillChange { | ||
object: any, | ||
type: 'update' | 'add', | ||
name: string, | ||
newValue: any | ||
} | ||
|
||
declare interface IValueWillChange<T> { | ||
object: any, | ||
type: 'update', | ||
newValue: T | ||
} | ||
|
||
declare interface IObservableValue<T> { | ||
get(): T, | ||
set(value: T): void, | ||
intercept(handler: IInterceptor<IValueWillChange<T>>): Lambda, | ||
observe( | ||
listener: (newValue: T, oldValue: T) => void, fireImmediately?: boolean | ||
): Lambda | ||
} | ||
|
||
declare interface Iterator<T> { | ||
next(): { | ||
done: boolean, | ||
value?: T | ||
} | ||
} | ||
|
||
declare interface Lambda { | ||
(): void, | ||
name?: string | ||
} | ||
|
||
declare class ObservableMap<V> { | ||
$mobx: {}; | ||
name: string; | ||
interceptors: any; | ||
changeListeners: any; | ||
constructor(initialData?: IMapEntries<V> | IKeyValueMap<V>, valueModeFunc?: Function): this; | ||
has(key: string): boolean; | ||
set(key: string, value: V): void; | ||
delete(key: string): boolean; | ||
get(key: string): V; | ||
keys(): string[] & Iterator<string>; | ||
values(): V[] & Iterator<V>; | ||
entries(): IMapEntries<V> & Iterator<IMapEntry<V>>; | ||
forEach( | ||
callback: (value: V, key: string, object: IKeyValueMap<V>) => void, thisArg?: any | ||
): void; | ||
merge(other: ObservableMap<V> | IKeyValueMap<V>): ObservableMap<V>; | ||
clear(): void; | ||
size: number; | ||
toJS(): IKeyValueMap<V>; | ||
toJs(): IKeyValueMap<V>; | ||
toJSON(): IKeyValueMap<V>; | ||
toString(): string; | ||
observe(listener: (changes: IMapChange<V>) => void, fireImmediately?: boolean): Lambda; | ||
intercept(handler: IInterceptor<IMapWillChange<V>>): Lambda | ||
} | ||
|
||
declare function action(targetOrName: any, propertyKeyOrFuc?: any, descriptor?: PropertyDescriptor): any; | ||
declare function runInAction<T>(name: string, block: () => T, scope?: any): T; | ||
declare function isAction(thing: any): boolean; | ||
declare function autorun(nameOrFunction: string | (r: IReactionPublic) => void, viewOrScope?: any, scope?: any): any; | ||
declare function when(predicate: () => boolean, effect: Lambda, scope?: any): any | ||
declare function autorunAsync(func: (r: IReactionPublic) => void, delay?: number, scope?: any): any | ||
declare function reaction<T>( | ||
expression: () => T, effect: (arg: T, r: IReactionPublic) => void, fireImmediately?: boolean, delay?: number, scope?: any | ||
): any | ||
|
||
declare function computed<T>(target: any, key?: string, baseDescriptor?: PropertyDescriptor): any | ||
declare function createTransformer<A, B>( | ||
transformer: ITransformer<A, B>, onCleanup?: (resultObject: ?B | any, sourceObject?: A) => void | ||
): ITransformer<A, B> | ||
declare function expr<T>(expr: () => T, scope?: any): T | ||
declare function extendObservable<A, B>(target: A, ...properties: B[]): A & B | ||
|
||
|
||
declare function intercept(object: Object, property: string, handler: IInterceptor<any>): Lambda; | ||
|
||
declare function isComputed(value: any, property?: string): boolean | ||
|
||
declare function isObservable(value: any, property?: string): boolean | ||
|
||
declare function observable<T>(value: T): any | ||
|
||
declare function observe( | ||
object: any, property: string, listener: (newValue: any, oldValue?: any) => void, fireImmediately?: boolean | ||
): Lambda | ||
|
||
declare function toJS(source: any, detectCycles: boolean, ___alreadySeen: [any, any][]): any | ||
declare function toJSlegacy(source: any, detectCycles?: boolean, ___alreadySeen?: [any, any][]): any | ||
declare function whyRun(thing?: any, prop?: string): string | ||
declare function useStrict(strict: boolean): any | ||
|
||
declare function isStrictModeEnabled(): boolean | ||
declare function untracked<T>(action: () => T): T | ||
|
||
declare function spy(listener: (change: any) => void): Lambda | ||
|
||
declare function transaction<T>(action: () => T, thisArg?: any, report?: boolean): T | ||
|
||
declare function asReference<T>(value: T): T | ||
declare function asStructure<T>(value: T): T | ||
declare function asFlat<T>(value: T): T | ||
declare function asMap<T>(data: IKeyValueMap<T>, modifierFunc?: Function): ObservableMap<T> | ||
declare function isObservableArray(thing: any): boolean | ||
|
||
declare function map<V>( | ||
initialValues?: IMapEntries<V> | IKeyValueMap<V>, valueModifier?: Function | ||
): ObservableMap<V> | ||
|
||
declare function isObservableObject<T>(thing: T): boolean | ||
|
||
declare function isArrayLike(x: any): boolean | ||
|
||
declare class BaseAtom { | ||
name: string; | ||
isPendingUnobservation: boolean; | ||
observers: any[]; | ||
observersIndexes: {}; | ||
diffValue: number; | ||
lastAccessedBy: number; | ||
lowestObserverState: IDerivationState; | ||
constructor(name?: string): this; | ||
onBecomeUnobserved(): void; | ||
reportObserved(): void; | ||
reportChanged(): void; | ||
toString(): string | ||
} | ||
|
||
declare class Atom { | ||
name: string; | ||
onBecomeObservedHandler: () => void; | ||
onBecomeUnobservedHandler: () => void; | ||
isPendingUnobservation: boolean; | ||
isBeingTracked: boolean; | ||
constructor(name?: string, onBecomeObservedHandler?: () => void, onBecomeUnobservedHandler?: () => void): this; | ||
reportObserved(): boolean; | ||
onBecomeUnobserved(): void | ||
} | ||
|
||
declare class Reaction { | ||
name: string; | ||
observing: any[]; | ||
newObserving: any[]; | ||
dependenciesState: IDerivationState; | ||
diffValue: number; | ||
runId: number; | ||
unboundDepsCount: number; | ||
___mapid: string; | ||
isDisposed: boolean; | ||
_isScheduled: boolean; | ||
_isTrackPending: boolean; | ||
_isRunning: boolean; | ||
constructor(name: string, onInvalidate: () => void): this; | ||
onBecomeStale(): void; | ||
schedule(): void; | ||
isScheduled(): boolean; | ||
runReaction(): void; | ||
track(fn: () => void): void; | ||
recoverFromError(): void; | ||
dispose(): void; | ||
getDisposer(): Lambda & { | ||
$mosbservable: Reaction | ||
}; | ||
toString(): string; | ||
whyRun(): string | ||
} | ||
} |
Oops, something went wrong.