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-4a2dc1"},"children":[{"type":"text","value":"function"}]},{"type":"element","tag":"span","props":{"class":"ct-13f5bd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-597c8c"},"children":[{"type":"text","value":"isFish"}]},{"type":"element","tag":"span","props":{"class":"ct-13f5bd"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-5d61f5"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-2cedea"},"children":[{"type":"text","value":":"}]},{"type":"element","tag":"span","props":{"class":"ct-13f5bd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-ab54ed"},"children":[{"type":"text","value":"Fish"}]},{"type":"element","tag":"span","props":{"class":"ct-13f5bd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-2cedea"},"children":[{"type":"text","value":"|"}]},{"type":"element","tag":"span","props":{"class":"ct-13f5bd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-ab54ed"},"children":[{"type":"text","value":"Bird"}]},{"type":"element","tag":"span","props":{"class":"ct-13f5bd"},"children":[{"type":"text","value":")"}]},{"type":"element","tag":"span","props":{"class":"ct-2cedea"},"children":[{"type":"text","value":":"}]},{"type":"element","tag":"span","props":{"class":"ct-13f5bd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-5d61f5"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-13f5bd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-2cedea"},"children":[{"type":"text","value":"is"}]},{"type":"element","tag":"span","props":{"class":"ct-13f5bd"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-ab54ed"},"children":[{"type":"text","value":"Fish"}]},{"type":"element","tag":"span","props":{"class":"ct-13f5bd"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-8f2e5b"},"children":[{"type":"text","value":"return"}]},{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":" ("}]},{"type":"element","tag":"span","props":{"class":"ct-66551e"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-8f2e5b"},"children":[{"type":"text","value":"as"}]},{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-aad8fc"},"children":[{"type":"text","value":"Fish"}]},{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":")."}]},{"type":"element","tag":"span","props":{"class":"ct-66551e"},"children":[{"type":"text","value":"swim"}]},{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-8f2e5b"},"children":[{"type":"text","value":"!=="}]},{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-ecd9dc"},"children":[{"type":"text","value":"undefined"}]},{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":";"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-dca786"},"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-4b8612"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-372d2f"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-8f2e5b"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-dbdf1d"},"children":[{"type":"text","value":"getSmallPet"}]},{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":"();"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":" "}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-8f2e5b"},"children":[{"type":"text","value":"if"}]},{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":" ("}]},{"type":"element","tag":"span","props":{"class":"ct-dbdf1d"},"children":[{"type":"text","value":"isFish"}]},{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-66551e"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":")) {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-66551e"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-dbdf1d"},"children":[{"type":"text","value":"swim"}]},{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":"();"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":"} "}]},{"type":"element","tag":"span","props":{"class":"ct-8f2e5b"},"children":[{"type":"text","value":"else"}]},{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-66551e"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-dbdf1d"},"children":[{"type":"text","value":"fly"}]},{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":"();"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-dca786"},"children":[{"type":"text","value":"}"}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-dbdf1d{color:#D2A8FF}.ct-372d2f{color:#79C0FF}.ct-4b8612{color:#FF7B72}.ct-ecd9dc{color:#79C0FF}.ct-aad8fc{color:#FFA657}.ct-66551e{color:#C9D1D9}.ct-8f2e5b{color:#FF7B72}.ct-dca786{color:#C9D1D9}.ct-ab54ed{color:#FFA657}.ct-2cedea{color:#FF7B72}.ct-5d61f5{color:#FFA657}.ct-597c8c{color:#D2A8FF}.ct-13f5bd{color:#C9D1D9}.ct-4a2dc1{color:#FF7B72}.light .ct-4a2dc1{color:#073642}.light .ct-13f5bd{color:#657B83}.light .ct-597c8c{color:#268BD2}.light .ct-5d61f5{color:#657B83}.light .ct-2cedea{color:#859900}.light .ct-ab54ed{color:#268BD2}.light .ct-dca786{color:#657B83}.light .ct-8f2e5b{color:#859900}.light .ct-66551e{color:#268BD2}.light .ct-aad8fc{color:#268BD2}.light .ct-ecd9dc{color:#B58900}.light .ct-4b8612{color:#073642}.light .ct-372d2f{color:#268BD2}.light .ct-dbdf1d{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"}