Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/static/shared/js/typing_status.js.flow

19 lines
426 B
Plaintext
Raw Normal View History

shared: Describe interface of typing_status in Flow. This allows the mobile app to stay well-typed while using this code.
2019-10-04 23:37:28 +02:00
/**
* @flow strict
*/
"use strict";
typing_status: Mark recipient array as allowing number subtypes. Concretely, we'll use this with a `UserId` type which is an "opaque type alias" of `number` -- it's secretly implemented as simply `number`, and it can be consumed by anything that wants a `number` (in other words, it's a subtype of `number`), but the fact that it secretly just is `number` is private to the module that defines the type. As far as the typing_status code is concerned, allowing this to be a subtype of `number` just means that the code doesn't ever try to inject new numbers of its own into the recipients arrays that it passes around.
2020-12-29 23:40:25 +01:00
type RecipientUserIds<UserId: number> = $ReadOnlyArray<UserId>;
shared: Describe interface of typing_status in Flow. This allows the mobile app to stay well-typed while using this code.
2019-10-04 23:37:28 +02:00
typing_status: Mark recipient array as allowing number subtypes. Concretely, we'll use this with a `UserId` type which is an "opaque type alias" of `number` -- it's secretly implemented as simply `number`, and it can be consumed by anything that wants a `number` (in other words, it's a subtype of `number`), but the fact that it secretly just is `number` is private to the module that defines the type. As far as the typing_status code is concerned, allowing this to be a subtype of `number` just means that the code doesn't ever try to inject new numbers of its own into the recipients arrays that it passes around.
2020-12-29 23:40:25 +01:00
type Worker<UserId> = {|
shared: Describe interface of typing_status in Flow. This allows the mobile app to stay well-typed while using this code.
2019-10-04 23:37:28 +02:00
get_current_time: () => number, // as ms since epoch
typing_status: Mark recipient array as allowing number subtypes. Concretely, we'll use this with a `UserId` type which is an "opaque type alias" of `number` -- it's secretly implemented as simply `number`, and it can be consumed by anything that wants a `number` (in other words, it's a subtype of `number`), but the fact that it secretly just is `number` is private to the module that defines the type. As far as the typing_status code is concerned, allowing this to be a subtype of `number` just means that the code doesn't ever try to inject new numbers of its own into the recipients arrays that it passes around.
2020-12-29 23:40:25 +01:00
notify_server_start: RecipientUserIds<UserId> => void,
notify_server_stop: RecipientUserIds<UserId> => void
shared: Describe interface of typing_status in Flow. This allows the mobile app to stay well-typed while using this code.
2019-10-04 23:37:28 +02:00
|};
typing_status: Mark recipient array as allowing number subtypes. Concretely, we'll use this with a `UserId` type which is an "opaque type alias" of `number` -- it's secretly implemented as simply `number`, and it can be consumed by anything that wants a `number` (in other words, it's a subtype of `number`), but the fact that it secretly just is `number` is private to the module that defines the type. As far as the typing_status code is concerned, allowing this to be a subtype of `number` just means that the code doesn't ever try to inject new numbers of its own into the recipients arrays that it passes around.
2020-12-29 23:40:25 +01:00
declare export function update<UserId>(
worker: Worker<UserId>,
new_recipient: RecipientUserIds<UserId> | null
typing_status: Use parameters for data rather than callbacks. The real purpose these two callbacks serve is exactly what an ordinary parameter is perfect for: * Each has just one call site, at the top of the function. * They're not done for side effects; the point is what they return. * The function doesn't pass them any arguments of its own, or otherwise express any internal knowledge that doesn't just as properly belong to its caller. So, push the calls to these callbacks up into the function's caller, and pass in the data they return instead. This greatly simplifies the interface of `handle_text_input` and of `typing_status` in general.
2019-10-21 23:03:19 +02:00
): void;