{"id":13726009,"url":"https://github.com/cometkim/mattermost-typed","last_synced_at":"2025-05-07T21:30:50.179Z","repository":{"id":57292600,"uuid":"104340094","full_name":"cometkim/mattermost-typed","owner":"cometkim","description":"⛔ DEPRECATED ⛔ Flow type definition library for Mattermost","archived":true,"fork":false,"pushed_at":"2018-04-11T02:43:37.000Z","size":81,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-20T17:23:18.726Z","etag":null,"topics":["flow","libdefs","mattermost"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cometkim.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-21T11:33:18.000Z","updated_at":"2023-01-28T20:51:47.000Z","dependencies_parsed_at":"2022-08-27T12:21:01.823Z","dependency_job_id":null,"html_url":"https://github.com/cometkim/mattermost-typed","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cometkim%2Fmattermost-typed","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cometkim%2Fmattermost-typed/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cometkim%2Fmattermost-typed/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cometkim%2Fmattermost-typed/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cometkim","download_url":"https://codeload.github.com/cometkim/mattermost-typed/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250746200,"owners_count":21480348,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flow","libdefs","mattermost"],"created_at":"2024-08-03T01:02:47.139Z","updated_at":"2025-05-07T21:30:49.919Z","avatar_url":"https://github.com/cometkim.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"⛔ DEPRECATED ⛔\n\nThis library has been deprecated by https://github.com/cometkim/mattermost-typed/issues/18\n\nBut [mattermost-redux](htttps://github.com/mattermost/mattermost-redux) is starting to support flowtype! Please consider to contribute types to the Mattermost codebase.\n\n# Mattermost type definitions \n[Flow](https://flow.org/) type definition library for [Mattermost](https://about.mattermost.com/)\n\nCompatible with [Mattermost API](https://api.mattermost.com) and [Mattermost Redux](https://github.com/mattermost/mattermost-redux)\n\nThis project will help you in your Mattermost projects:\n* Understanding Mattermost codebase.\n* Preventing building bad request or parsing response incorrectly.\n* Improves productivity with intelligence support.\n\n## Install\n\nInstall\n```sh\nyarn add --dev mattermost-typed\nnpx flow init # initialize flow if you've not.\n```\n\nAdd a line under libs tag on your `.flowconfig`\n```diff\n[libs]\n+./node_modules/mattermost-typed/\n```\n\nAdd the preset (if you use BabelJS)\n```sh\nyarn add --dev babel-preset-flow\n```\n\n`.babelrc`\n```diff\npreset: [\n+  \"flow\"\n]\n```\n\n## How to use\n\n### By CLI\n```\nnpx flow [COMMAND] \n```\n\nor add script into your `package.json`\n```diff\nscripts: {\n+  \"flow\": \"flow\"\n}\n```\n\n### VSCode Extentions\n* [Flow Language Support](https://marketplace.visualstudio.com/items?itemName=flowtype.flow-for-vscode)\n\n## Why? \nYou might wonder if this is really necessary.  \nWell, Here is why I came to think it is - Expect the type of Get Posts API.\n\nI was building a Mattermost integration and I expected it would of course be an array of Post.  \nAnd I had to see the result of `map is not a function` because of the result of the Get Posts API that looks like:\n```json\n{\n  \"order\": [\n    \"post_id1\",\n    \"post_id2\"\n  ],\n  \"posts\": {\n    \"post1\": {},\n    \"post2\": {}\n  }\n}\n```\n\n* It was your fault. Mattermost have documentation for it.\n* Why did you not write test, evil.\n\nYou can think it is wrong not to check the documentation or write test code. But generally it could be skip when productivity is important like in prototyping.\ntype checking is simple and a great solution to avoid mistakes.\n\n* PropTypes is not enough?\n\nPropTypes is great sollution to assert types. But it's only for React component.\n\n## Typescript?\nTODO\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcometkim%2Fmattermost-typed","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcometkim%2Fmattermost-typed","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcometkim%2Fmattermost-typed/lists"}