Skip to content

Chore: Migrate methods/getRoomInfo to TS #3695

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gerzonc merged 8 commits into from
Feb 19, 2022
Merged

Chore: Migrate methods/getRoomInfo to TS #3695

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3b2ee45
migrate getRoomInfo to TS
gerzonc Feb 8, 2022
9bcab2f
update room type
gerzonc Feb 9, 2022
4ae65fd
update types
gerzonc Feb 9, 2022
163c3d1
Merge branch 'develop' into chore.migrate-getroominfo-to-ts
gerzonc Feb 10, 2022
24eb150
Merge branch 'develop' into chore.migrate-getroominfo-to-ts
gerzonc Feb 15, 2022
b2e52e8
Merge branch 'develop' into chore.migrate-getroominfo-to-ts
gerzonc Feb 18, 2022
bc292e6
Fix lint error
gerzonc Feb 18, 2022
69e364a
Merge branch 'develop' into chore.migrate-getroominfo-to-ts
gerzonc Feb 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions app/definitions/IRoom.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ export interface IRoom {
prid: string;
t: SubscriptionType;
name: string;
fname?: string;
teamMain: boolean;
alert?: boolean;
customFields: string[];
Expand Down
3 changes: 2 additions & 1 deletion app/lib/methods/getRoomInfo.js → app/lib/methods/getRoomInfo.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import { IRoom } from '../../definitions';
import { getSubscriptionByRoomId } from '../database/services/Subscription';
import RocketChat from '../rocketchat';

const getRoomInfo = async rid => {
const getRoomInfo = async (rid: string): Promise<Partial<IRoom> | null> => {

@AlexAlexandre AlexAlexandre Feb 8, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if use a Partial here is the best approach, take a look at the lint erros.

@gerzonc gerzonc Feb 9, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a room, just that getRoomInfo returns less information than what the IRoom interface does, that's why lint complains, we defined this.room with an object with some properties from IRoom, but on the context we're using it is actually a room with less attributes, that's why I opted for Partial<IRoom>.

@AlexAlexandre AlexAlexandre Feb 9, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So you can use the Pick<Type, keys>.
Using the keys required at RoomInfo
E.g: Pick<IRoom, 'rid' | 'name' | 'fname' | 't'>

let result;
result = await getSubscriptionByRoomId(rid);
if (result) {
Expand Down