muerwre.github.io/docs/api/_content/query/iZIUw8pCoM.json

{"_path":"/typescript/type-guards","_dir":"typescript","_draft":false,"_partial":false,"_locale":"en","_empty":false,"title":"Type Guards","description":"Useful for type checking at compile and run time:","excerpt":{"type":"root","children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Useful for type checking at compile and run time:"}]},{"type":"element","tag":"code","props":{"code":"function isFish(pet: Fish | Bird): pet is Fish {\n  return (pet as Fish).swim !== undefined;\n}\n","language":"typescript"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"function isFish(pet: Fish | Bird): pet is Fish {\n  return (pet as Fish).swim !== undefined;\n}\n"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Usage:"}]},{"type":"element","tag":"code","props":{"code":"const pet = getSmallPet();\n \nif (isFish(pet)) {\n  pet.swim();\n} else {\n  pet.fly();\n}\n","language":"typescript"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"const pet = getSmallPet();\n \nif (isFish(pet)) {\n  pet.swim();\n} else {\n  pet.fly();\n}\n"}]}]}]}]},"body":{"type":"root","children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Useful for type checking at compile and run time:"}]},{"type":"element","tag":"code","props":{"code":"function isFish(pet: Fish | Bird): pet is Fish {\n  return (pet as Fish).swim !== undefined;\n}\n","language":"typescript"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-d04dfb"},"children":[{"type":"text","value":"function"}]},{"type":"element","tag":"span","props":{"class":"ct-8cf3d7"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-97f0fb"},"children":[{"type":"text","value":"isFish"}]},{"type":"element","tag":"span","props":{"class":"ct-8cf3d7"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-92cd35"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-577088"},"children":[{"type":"text","value":":"}]},{"type":"element","tag":"span","props":{"class":"ct-8cf3d7"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-01c181"},"children":[{"type":"text","value":"Fish"}]},{"type":"element","tag":"span","props":{"class":"ct-8cf3d7"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-577088"},"children":[{"type":"text","value":"|"}]},{"type":"element","tag":"span","props":{"class":"ct-8cf3d7"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-01c181"},"children":[{"type":"text","value":"Bird"}]},{"type":"element","tag":"span","props":{"class":"ct-8cf3d7"},"children":[{"type":"text","value":")"}]},{"type":"element","tag":"span","props":{"class":"ct-577088"},"children":[{"type":"text","value":":"}]},{"type":"element","tag":"span","props":{"class":"ct-8cf3d7"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-92cd35"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-8cf3d7"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-577088"},"children":[{"type":"text","value":"is"}]},{"type":"element","tag":"span","props":{"class":"ct-8cf3d7"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-01c181"},"children":[{"type":"text","value":"Fish"}]},{"type":"element","tag":"span","props":{"class":"ct-8cf3d7"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-ac0089"},"children":[{"type":"text","value":"return"}]},{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":" ("}]},{"type":"element","tag":"span","props":{"class":"ct-6117f4"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-ac0089"},"children":[{"type":"text","value":"as"}]},{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-24f66b"},"children":[{"type":"text","value":"Fish"}]},{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":")."}]},{"type":"element","tag":"span","props":{"class":"ct-6117f4"},"children":[{"type":"text","value":"swim"}]},{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-ac0089"},"children":[{"type":"text","value":"!=="}]},{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-e42bed"},"children":[{"type":"text","value":"undefined"}]},{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":";"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":"}"}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Usage:"}]},{"type":"element","tag":"code","props":{"code":"const pet = getSmallPet();\n \nif (isFish(pet)) {\n  pet.swim();\n} else {\n  pet.fly();\n}\n","language":"typescript"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-d5f7ca"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3dcf96"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-ac0089"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1810d7"},"children":[{"type":"text","value":"getSmallPet"}]},{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":"();"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":" "}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-ac0089"},"children":[{"type":"text","value":"if"}]},{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":" ("}]},{"type":"element","tag":"span","props":{"class":"ct-1810d7"},"children":[{"type":"text","value":"isFish"}]},{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-6117f4"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":")) {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-6117f4"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-1810d7"},"children":[{"type":"text","value":"swim"}]},{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":"();"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":"} "}]},{"type":"element","tag":"span","props":{"class":"ct-ac0089"},"children":[{"type":"text","value":"else"}]},{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-6117f4"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-1810d7"},"children":[{"type":"text","value":"fly"}]},{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":"();"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-ac8dea"},"children":[{"type":"text","value":"}"}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-1810d7{color:#D2A8FF}.ct-3dcf96{color:#79C0FF}.ct-d5f7ca{color:#FF7B72}.ct-e42bed{color:#79C0FF}.ct-24f66b{color:#FFA657}.ct-6117f4{color:#C9D1D9}.ct-ac0089{color:#FF7B72}.ct-ac8dea{color:#C9D1D9}.ct-01c181{color:#FFA657}.ct-577088{color:#FF7B72}.ct-92cd35{color:#FFA657}.ct-97f0fb{color:#D2A8FF}.ct-8cf3d7{color:#C9D1D9}.ct-d04dfb{color:#FF7B72}.light .ct-d04dfb{color:#073642}.light .ct-8cf3d7{color:#657B83}.light .ct-97f0fb{color:#268BD2}.light .ct-92cd35{color:#657B83}.light .ct-577088{color:#859900}.light .ct-01c181{color:#268BD2}.light .ct-ac8dea{color:#657B83}.light .ct-ac0089{color:#859900}.light .ct-6117f4{color:#268BD2}.light .ct-24f66b{color:#268BD2}.light .ct-e42bed{color:#B58900}.light .ct-d5f7ca{color:#073642}.light .ct-3dcf96{color:#268BD2}.light .ct-1810d7{color:#268BD2}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[]}},"_type":"markdown","_id":"content:Typescript:Type guards.md","_source":"content","_file":"Typescript/Type guards.md","_extension":"md"}