muerwre.github.io/docs/api/_content/query/iZIUw8pCoM.json
2024-03-21 11:20:30 +00:00

1 line
No EOL
11 KiB
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-d84b94"},"children":[{"type":"text","value":"function"}]},{"type":"element","tag":"span","props":{"class":"ct-8fe02f"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-d29147"},"children":[{"type":"text","value":"isFish"}]},{"type":"element","tag":"span","props":{"class":"ct-8fe02f"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-7f7efa"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-e5c636"},"children":[{"type":"text","value":":"}]},{"type":"element","tag":"span","props":{"class":"ct-8fe02f"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-939d0a"},"children":[{"type":"text","value":"Fish"}]},{"type":"element","tag":"span","props":{"class":"ct-8fe02f"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-e5c636"},"children":[{"type":"text","value":"|"}]},{"type":"element","tag":"span","props":{"class":"ct-8fe02f"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-939d0a"},"children":[{"type":"text","value":"Bird"}]},{"type":"element","tag":"span","props":{"class":"ct-8fe02f"},"children":[{"type":"text","value":")"}]},{"type":"element","tag":"span","props":{"class":"ct-e5c636"},"children":[{"type":"text","value":":"}]},{"type":"element","tag":"span","props":{"class":"ct-8fe02f"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-7f7efa"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-8fe02f"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-e5c636"},"children":[{"type":"text","value":"is"}]},{"type":"element","tag":"span","props":{"class":"ct-8fe02f"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-939d0a"},"children":[{"type":"text","value":"Fish"}]},{"type":"element","tag":"span","props":{"class":"ct-8fe02f"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a56ef8"},"children":[{"type":"text","value":"return"}]},{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":" ("}]},{"type":"element","tag":"span","props":{"class":"ct-ba46a6"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a56ef8"},"children":[{"type":"text","value":"as"}]},{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-200008"},"children":[{"type":"text","value":"Fish"}]},{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":")."}]},{"type":"element","tag":"span","props":{"class":"ct-ba46a6"},"children":[{"type":"text","value":"swim"}]},{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a56ef8"},"children":[{"type":"text","value":"!=="}]},{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-1d16bf"},"children":[{"type":"text","value":"undefined"}]},{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":";"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-37d612"},"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-6136c4"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-9e6c43"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-a56ef8"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-e0a066"},"children":[{"type":"text","value":"getSmallPet"}]},{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":"();"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":" "}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-a56ef8"},"children":[{"type":"text","value":"if"}]},{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":" ("}]},{"type":"element","tag":"span","props":{"class":"ct-e0a066"},"children":[{"type":"text","value":"isFish"}]},{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-ba46a6"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":")) {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-ba46a6"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-e0a066"},"children":[{"type":"text","value":"swim"}]},{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":"();"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":"} "}]},{"type":"element","tag":"span","props":{"class":"ct-a56ef8"},"children":[{"type":"text","value":"else"}]},{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-ba46a6"},"children":[{"type":"text","value":"pet"}]},{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":"."}]},{"type":"element","tag":"span","props":{"class":"ct-e0a066"},"children":[{"type":"text","value":"fly"}]},{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":"();"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-37d612"},"children":[{"type":"text","value":"}"}]}]}]}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-e0a066{color:#D2A8FF}.ct-9e6c43{color:#79C0FF}.ct-6136c4{color:#FF7B72}.ct-1d16bf{color:#79C0FF}.ct-200008{color:#FFA657}.ct-ba46a6{color:#C9D1D9}.ct-a56ef8{color:#FF7B72}.ct-37d612{color:#C9D1D9}.ct-939d0a{color:#FFA657}.ct-e5c636{color:#FF7B72}.ct-7f7efa{color:#FFA657}.ct-d29147{color:#D2A8FF}.ct-8fe02f{color:#C9D1D9}.ct-d84b94{color:#FF7B72}.light .ct-d84b94{color:#073642}.light .ct-8fe02f{color:#657B83}.light .ct-d29147{color:#268BD2}.light .ct-7f7efa{color:#657B83}.light .ct-e5c636{color:#859900}.light .ct-939d0a{color:#268BD2}.light .ct-37d612{color:#657B83}.light .ct-a56ef8{color:#859900}.light .ct-ba46a6{color:#268BD2}.light .ct-200008{color:#268BD2}.light .ct-1d16bf{color:#B58900}.light .ct-6136c4{color:#073642}.light .ct-9e6c43{color:#268BD2}.light .ct-e0a066{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"}