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-6cb31c"},"children":[{"type":"text","value":"function"}]},{"type":"element","tag":"span","props":{"class":"ct-20801c"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1b2598"},"children":[{"type":"text","value":"isFish"}]},{"type":"element","tag":"span","props":{"class":"ct-20801c"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-b8d0d9"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-3398f7"},"children":[{"type":"text","value":":"}]},{"type":"element","tag":"span","props":{"class":"ct-20801c"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-2616f1"},"children":[{"type":"text","value":"Fish"}]},{"type":"element","tag":"span","props":{"class":"ct-20801c"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3398f7"},"children":[{"type":"text","value":"|"}]},{"type":"element","tag":"span","props":{"class":"ct-20801c"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-2616f1"},"children":[{"type":"text","value":"Bird"}]},{"type":"element","tag":"span","props":{"class":"ct-20801c"},"children":[{"type":"text","value":")"}]},{"type":"element","tag":"span","props":{"class":"ct-3398f7"},"children":[{"type":"text","value":":"}]},{"type":"element","tag":"span","props":{"class":"ct-20801c"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-b8d0d9"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-20801c"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-3398f7"},"children":[{"type":"text","value":"is"}]},{"type":"element","tag":"span","props":{"class":"ct-20801c"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-2616f1"},"children":[{"type":"text","value":"Fish"}]},{"type":"element","tag":"span","props":{"class":"ct-20801c"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-569534"},"children":[{"type":"text","value":"return"}]},{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":" ("}]},{"type":"element","tag":"span","props":{"class":"ct-bbea01"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-569534"},"children":[{"type":"text","value":"as"}]},{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-27f9e1"},"children":[{"type":"text","value":"Fish"}]},{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":")."}]},{"type":"element","tag":"span","props":{"class":"ct-bbea01"},"children":[{"type":"text","value":"swim"}]},{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-569534"},"children":[{"type":"text","value":"!=="}]},{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-61dd7f"},"children":[{"type":"text","value":"undefined"}]},{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":";"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"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-653878"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-d1e62b"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-569534"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-92f8ca"},"children":[{"type":"text","value":"getSmallPet"}]},{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":"();"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":" "}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-569534"},"children":[{"type":"text","value":"if"}]},{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":" ("}]},{"type":"element","tag":"span","props":{"class":"ct-92f8ca"},"children":[{"type":"text","value":"isFish"}]},{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-bbea01"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":")) {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-bbea01"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-92f8ca"},"children":[{"type":"text","value":"swim"}]},{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":"();"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":"} "}]},{"type":"element","tag":"span","props":{"class":"ct-569534"},"children":[{"type":"text","value":"else"}]},{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-bbea01"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-92f8ca"},"children":[{"type":"text","value":"fly"}]},{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":"();"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-3c2cc2"},"children":[{"type":"text","value":"}"}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-92f8ca{color:#D2A8FF}.ct-d1e62b{color:#79C0FF}.ct-653878{color:#FF7B72}.ct-61dd7f{color:#79C0FF}.ct-27f9e1{color:#FFA657}.ct-bbea01{color:#C9D1D9}.ct-569534{color:#FF7B72}.ct-3c2cc2{color:#C9D1D9}.ct-2616f1{color:#FFA657}.ct-3398f7{color:#FF7B72}.ct-b8d0d9{color:#FFA657}.ct-1b2598{color:#D2A8FF}.ct-20801c{color:#C9D1D9}.ct-6cb31c{color:#FF7B72}.light .ct-6cb31c{color:#073642}.light .ct-20801c{color:#657B83}.light .ct-1b2598{color:#268BD2}.light .ct-b8d0d9{color:#657B83}.light .ct-3398f7{color:#859900}.light .ct-2616f1{color:#268BD2}.light .ct-3c2cc2{color:#657B83}.light .ct-569534{color:#859900}.light .ct-bbea01{color:#268BD2}.light .ct-27f9e1{color:#268BD2}.light .ct-61dd7f{color:#B58900}.light .ct-653878{color:#073642}.light .ct-d1e62b{color:#268BD2}.light .ct-92f8ca{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"}