Share
Embed
コードには型アノテーションよりも要件アノテーションを増やせ!/harajukuts2
2022/1/28 Harajuku.ts Meetup #2 にて使用した資料です。
11ページ目はString#join()ではなくArray#join()の誤りでした。お詫びいたします。
OKUNOKENTARO
January 28, 2022
Transcript
51 slides
-
ͳͥ5ZQF4DSJQUΛ͏ͷ͔ ʁ w +BWB4DSJQUॻ͍͍ͯͯϛεΛ͢Δݴޠ͔ͩΒͰ͋Δ w ͪΖΜ5ZQF4DSJQUॻ͍͍ͯͯϛεΛ͢ΔݴޠͰ͋Δ w ϛε͔ͯ͠Βϛεʹؾ͘ ·Ͱͷ͕͚࣌ؒΕ͍΄Ͳخ͍͠ w
ͦͦϛε͠ͳ͍Α ͏ͳߏจͰ͋Εͬͱخ͍͠ wʮઈରʹϛεΛ͠ͳ͍ਓʯ ͕։ൃ͢ΔͳΒ+BWB4DSJQUͷ··͓͖ʹͲ͏ ͧ -
ۃͳྫ function add(a, b) { return a + b; }
࣮ऀͷ͠ࢉΛఆ࣮ͯͨ͠͠ͷʹɺ ར༻ऀ͜ͷؔΛจࣈྻͷ࿈݁ͷͨΊͩͱޡղͯ͠͠·ͬͨ ʂ -
ҙࢥૄ௨ͷϛε w ίʔ υΛॻ͍͍ͯΔ্ͰͷϛεUZQPɺ ͏ ͔ͬΓআͳͲ༷ʑ w ։ൃऀಉ࢜ͷҙࢥૄ௨͕ίʔ υ্Ͱ݁͠ͳ͍͜ͱ
ҙࢥૄ௨ͷϛεͱݺΑ ͏ w จࣈྻ࿈݁ؔͱޡղͯ͠͠·ͬͨ։ൃऀɺ add()͕ؔͲ͏͍͏ؔͳͷ͔࣮ऀຊਓʹฉ͘ ·ͰѲͰ͖ͳ͔ͬͨ -
ଞਓͷίʔ υɺ ਖ਼͠ ͘ղऍͯ͠ಡΜͰ·͔͢ ʁ w ͪΖΜ͜Ε͘͢͝ۃͳྫ ʢ+ ͷՃࢉʹͷΈ༻͍ͯɺ
จࣈྻ࿈݁ String#join() 5FNQMBUFMJUFSBMTΛ͏ํ͕Α Γʣ w ͔͠͠ɺ ۀ͜͏͍ͬͨ ʮଞਓͷίʔ υΛᴥᴪͳ͘ղऍͰ͖͍ͯΔ͔ʯ ͱ͍͏ ධՁͷ࿈ଓͰ͋Δ w ίʔ υதͷใྔ͕͍͠ͱɺ ͨͱ͑1BSTBCMFͳίʔ υͰ͋ͬͨͱͯ͠ ଞͷ։ൃऀͷҙਤ·Ͱղऍ͢Δͷ͍͠ -
ܕΞϊςʔγϣϯ function add(a: number, b: number): number { return a
+ b; } 5ZQF4DSJQUͰɺ ҾΓͷܕΛදه͢Δ ͜ΕΛܕΞϊςʔγϣϯ 5ZQFBOOPUBUJPOT ͱ͍͏ -
ܕΞϊςʔγϣϯ function add(a: number, b: number): number { return a
+ b; } ܕΞϊςʔγϣϯͷ͓͔͛Ͱɺ 5ZQF4DSJQUίϯύΠ ϥ͚ͩͰͳ͘ ίʔ υΛಡΉਓؒʹҙਤΛղऍ͢Δखॿ͚ͱͳΔ ʮ͋ɺ ͜Εnumber͔ͩΒจࣈྻ࿈݁ʹ͏ؔ͡Όͳ͍ͳ ʂ ʯ -
ܕΞϊςʔγϣϯॻ͍ͯ·͢ΑͶ w ͕͢͞ʹ5ZQF4DSJQUόʔδϣϯYʹಥೖ͠ख़͖ͯͨ͠ w पΓͰॻ͍͍ͯΔ։ൃऀ͔ͳΓ૿͑ͨ w --noImplicitAny --noImplicitReturns ͳͲͷ
UTDPO fi H$PNQJMFS0QUJPOTͷ͓͔͛Ͱ Ξϊςʔγϣϯͷॻ͖࿙ΕΛ͙ํ๏ཱ֬͞Ε͍ͯΔ -
ཁ݅Ξϊςʔγϣϯ ʁ w ຊߘͷޠ w ͪΐͬͱΩϟονʔͳλΠ τϧʹ͔͚ͨͬͨͩ͠ͳͷͰ άάͬͯެࣜͷ υΩϡϝϯ
τͱ͔ग़͖ͯ·ͤΜ w ܕΞϊςʔγϣϯʹܕҎ্ͷใྔΛͨͤΔ͜ͱͰ ೝࣝͷᴥᴪΛΑ Γແ͘ ͢͜ͱΛతͱ͢Δͷ͕ຊ࣭ -
͜ ͏͍͏ ͜ͱɺ ͨ͜͠ͱ͋Δਓ type UserId = string; type BookId
= string; ຊΛཧ͢ΔΞϓϦ UserIdBookIdจࣈྻͳΜ͚ͩͲ۠ผ͍ͨ͠ʜ -
type UserId = string; type BookId = string; async function
fetchBook(id: BookId): Promise<Book> { // } export function BookCard(): JSX.Element { const [book, setBook] = useState<Book | null>(null); useEffect(() => { (async (): Promise<void> => { const result = await fetchBook(); setBook(result); })(); }, []); return <></>; } ͜Μͳঢ়گ͕͋ͬͨͱ͠·͠ΐ ͏ -
type UserId = string; type BookId = string; async function
fetchBook(id: BookId): Promise<Book> { // } export function BookCard(): JSX.Element { const [book, setBook] = useState<Book | null>(null); useEffect(() => { (async (): Promise<void> => { const result = await fetchBook(); setBook(result); })(); }, []); return <></>; } fetchBook()ؔʹBookIdܕͷҾΛͤΑͦ͞͏ Ͱ͢ -
const id: UserId = 'ckyx6c8xc000009jm8acefv2v'; const result = await fetchBook(id);
ຊʹ ʁ ʁ ʁ ίϯύΠϧ௨ͬͯΔΑ ʁ ʁ ʁ -
ίϯύΠ ϥ۠ผ͠·ͤΜ w typeΛͬͯstringʹผ໊Λ͚ͭͯ ͦΕ͋͘ ·ͰΤΠ ϦΞε ʢผ໊ʣ ʹ͗͢ͳ͍
w ͳͷͰυΩϡϝϯ τʹͪΌΜͱ5ZQF"MJBTFTͱॻ͔Ε͍ͯΔ https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-aliases w ਓؒʹผ໊Ͱ͋Δ͜ͱࣝผͰ͖Δ͕ ίϯύΠ ϥʹstringʹผ໊Λ͚ͨ͜ͱ͔͠Θ͍ͬͯͳ͍ w UserIdͱBookId͕ޓ͍ʹstringͷผ໊Ͱ͋Δͱ͍͏͚ͩͰ ͦΕΒ͕ޓ͍ʹ۠ผ͞Ε͏ Δ͖ͱ͍͏ཁ݅·ͰίϯύΠ ϥʹΘ͍ͬͯͳ͍ -
ͳΒΫϥε͔ ʁ class UserId { constructor(public readonly value: string) {}
} class BookId { constructor(public readonly value: string) {} } UserIdͱBookIdΛͦΕͧΕclassͰએݴͯ͠Έͨ -
5ZQF4DSJQU4USVDUVSBM5ZQJOHͰ͋Δ w 5ZQF4DSJQUܕͷผ໊Ͱ۠ผͨ͠Γɺ Ϋϥε໊͕ҟͳΔ͜ͱͰ۠ผ͢ΔͷͰͳ͘ ৗʹ ʮϓϩύςΟͷߏʯ ʹΑͬͯܕͷ۠ผΛ͚ͭΔ w ͜͏͍ͬͨܕͷผํࣜΛ4USVDUVSBM5ZQJOHͱ͍͏
w ͜ΕυΩϡϝϯ τʹهࡌ͞Ε͍ͯΔ https://www.typescriptlang.org/docs/handbook/type-compatibility.html w ܕ໊ͷҧ͍͚ͩͰܕ͕ҟͳ͍ͬͯΔͱผ͢Δํࣜ/PNJOBM5ZQJOHͱ͍͏ w 5ZQF4DSJQUͪ͜Βͷํࣜ࠾༻͍ͯ͠ͳ͍ -
ϓϩύςΟͷҰக class UserId { constructor(public readonly value: string) {} }
class BookId { constructor(public readonly value: string) {} } valueͱ͍͏ ϓϩύςΟ͕ݸ͋ΔΫϥε ͱ͍͏Ͱɺ ߏ͕Ұக͍ͯ͠Δ Αͬͯ4USVDUVSBM5ZQJOHʹج͍ͮͯ͜ΕΒಉҰܕͱΈͳ͞ΕΔ -
ϓϩύςΟ ΛҰகͤ͞ͳ͍Α ͏ʹ͢Δ class UserId { userId: unknown; constructor(public readonly
value: string) {} } class BookId { bookId: unknown; constructor(public readonly value: string) {} } ͦΕͧΕͷΫϥεʹҟͳΔ໊લͷμϛʔϓϩύςΟ Λ͢͜ͱͰ ߏ͕Ұக͠ͳ͍Α ͏ʹͨ͠ -
const id = new UserId('ckyx6c8xc000009jm8acefv2v'); const result = await fetchBook(id);
Argument of type 'UserId' is not assignable to parameter of type 'BookId'. Property 'bookId' is missing in type 'UserId' but required in type 'BookId'.(2345) Τϥʔʹͳͬͯ ͘Εͨ -
Ϧςϥϧͱ ͯ͠ѻ͑ͳ͍ w new UserId()͍ͯ͠ΔͨΊɺ ݁Ռtypeof id === 'object'ͱͳΔ w
จࣈྻϦςϥϧͰͳ͘ɺ valueΛϓϩύςΟ ͱ ͯ࣋ͭ͠ΦϒδΣΫ τʹͳΔ w toString()Λ࣮͢Ε[object Object]ճආͰ͖Δ͕ ͜ͷख๏Λࢼ͢ࡍʹຖճͦͷ࣮͕ඞཁ w μϛʔϓϩύςΟ Λੜ͞ͳ͖ΌࣝผͰ͖ͳ͍ͷඇຊ࣭త w Ϧςϥϧͷ··ѻ͑ͯɺ ͔ͭ/PNJOBM5ZQJOHͬΆ͍ܕผΛ͢Δʹʜ ʁ -
UZQF/PNJOBM w type Nominal<T, U>Λએݴ͢Δ w { __brand: U }ͱ͍͏ΦϒδΣΫ
τͱͷަࠩܕ & ʹ͢Δ͜ͱͰϦςϥϧͷ·· ۠ผͰ͖ΔΑ ͏ʹ͢Δ w ਖ਼֬ͳग़యൃݟͰ͖͍ͯͳ͍͕ෳͷจݙ͋Γ w #SBOEFE5ZQFTͱݺΕ͍ͯΔ͕ ʮ/PNJOBM5ZQJOHΛ࣮ݱ͍ͨ͠ͷ͔ͩΒʯ ͱ͍͏҆ͳຊਓతޠ๏Ͱ ࠓճNominal<T, U>ͱͨ͠ export type Nominal<T, U extends string> = T & { __brand: U }; -
/PNJOBMܕΛͬͯ࠶ઓ type Nominal<T, U extends string> = T & {
__brand: U }; type BookId = Nominal<string, 'BookId'>; type UserId = Nominal<string, 'UserId'>; const id = 'ckyx6c8xc000009jm8acefv2v' as UserId; const result = await fetchBook(id); Argument of type 'UserId' is not assignable to parameter of type 'BookId'. Type 'UserId' is not assignable to type '{ __brand: "BookId"; }'. Types of property '__brand' are incompatible. Type '"UserId"' is not assignable to type '"BookId"'.(2345) ͪΌΜͱ۠ผͰ͖͍ͯΔ -
type Nominal<T, U extends string> = T & { __brand:
U }; type BookId = Nominal<string, 'BookId'>; type UserId = Nominal<string, 'UserId'>; const id = 'ckyx6c8xc000009jm8acefv2v' as UserId; const result = await fetchBook(id); ʮͰBTېࢭͯ͠·ͤΜͰͨ͠ ʁ ʯ -
"TTFSUJPOGVODUJPOTΛ͏ Α ͏ʹ͢Δ w ͜ͷख๏ͰΧδϡΞϧʹas͕ग़͖ͯͯ͠·͍ ʮBTېࢭʯ ʹͯ͠͠· ͏ w ͦͷͨΊɺ
Nominal<T, U>ܕͷͰ͋Δͱ͍ࣔͨ͠߹ඞͣ 5ZQFQSFEJDBUFTɺ ·ͨ"TTFSUJPOGVODUJPOTΛ͏ Α ͏ʹ͢Δ -
BTTFSU4USJOH ؔΛ࡞ͬͯΈΔ export function isString(v: unknown): v is string {
return typeof v === 'string'; } export function assertString(v: unknown, target = ''): asserts v is string { if (!isString(v)) { throw new Error(`${target} should be string`.trim()); } } ͨΓલͷΑ ͏ͳ༰ͷ͕ؔͩɺ unknownܕΛstringܕͱΈͳͨ͢Ίʹɺ Θ͟Θ͟͜͏͍͕ͬͨؔඞཁ -
/PNJOBMܕͱ"TTFSUJPOGVODUJPOTͷԠ༻ import { isString } from './assert-string'; import { Nominal
} from './nominal'; type FilledString = Nominal<string, 'FilledString'>; function isFilledString(v: unknown): v is string { return isString(v) && v !== ''; } function assertFilledString( v: unknown, target = '' ): asserts v is FilledString { if (!isFilledString(v)) { throw new Error(`${target} should be not empty string`.trim()); } } type FilledStringΛએݴ͠ɺ ඞۭͣจࣈྻͰͳ͍͜ͱΛද໌͢Δ -
/PNJOBMܕͷෳ߹ import { FilledString, assertFilledString } from '../utils/filled-string'; import {
Nominal } from '../utils/nominal'; export type UserId = Nominal<FilledString, 'UserId'>; function assertUserId(v: unknown): asserts v is UserId { assertFilledString(v); } export function asUserId(v: unknown): UserId { assertUserId(v); return v; } ͞Βʹɺ FilledStringܕΛຬͨ͢ผՄೳܕͱͯ͠type UserIdΛએݴ͢Δɻ ಉख๏Ͱએݴ͢Δtype BookIdͱίϯύΠ ϥ͕۠ผͰ͖Δ্ʹ ۭจࣈؚ͕·Εಘͳ͍͜ͱอূࡁΈ ʂ ʢ"TTFSUJPOGVODUJPOʹࣗಈςε τͷ࣮ࢪ͕ඞਢʣ -
Ԡ༻ͷՄೳੑແݶେ w ͜ͷख๏Λ׆༻͢Δͱ Ϧςϥϧͷදݱͷ෯͕͕Δ w ྫ͑ʜ w ۭจࣈྻΛېࢭ͢Δ6TFS*Eܕ w ಛఆͷਖ਼نදݱΛຬ͍ͨͯ͠ͳ͍ͱΤϥʔͱͳΔ'PSNFEܕ
w খ/B/ΛೝΊͳ͍6OJY5JNFܕ w ۠ผՄೳͳ4FDPOEܕͱ.JMMJTFDPOEܕ w ͳͲͳͲ -
ܕΞϊςʔγϣϯ ʮܕ͔͠Θ͔Βͳ͍ʯ w fetchBook(id: string)Ͱ ͳΜΒ͔ͷจࣈྻΛҾʹͱΔ͜ͱ ͔͠Θ͔Βͳ͍ w ͦΕUserId͔͠Εͳ͍͠ɺ
ۭจࣈྻΛ͍͍͔ͯ͠͠Εͳ͍ w ܕΞϊςʔγϣϯ͔Β ʮstringܕͷͰ͋Δ͜ͱʯ Ҏ֎ͳʹΘ͔Βͳ͍ w લͷ+BWB4DSJQUˠ5ZQF4DSJQUͷ࣌ɺ ͜ΕͰཱͳΜͩͬͨ -
ܕΞϊςʔγϣϯʹؚΊΔใྔΛ૿͢ w type BookId = Nominal<FilledString, 'BookId'>Λએݴ͓ͯ͘͠ ͱ fetchBook(id:
BookId)ͱ͍͏γάωνϟ͔ΒಘΒΕΔใྔ͕ fetchBook(id: string)ʹൺ͙ͯͬͱ૿͢ w ͦΕUserIdͰμϝͱΘ͔Δ w ͦΕۭจࣈྻͰμϝͱΘ͔Δ w ࣮୲ऀʹޱ಄Ͱฉ͍ͯճΔඞཁ͕ͳ͍ w ͜ͷߟ͑ํܖϓϩάϥϛϯά ʢ%FTJHOCZ$POUSBDU %C$ͳͲͱʣ ͷ ํ๏ʹج͍͍ͮͯΔ w ಛʹࣄલ݅ෆม݅ʹ֘ -
தͷ͋ΔΞϊςʔγϣϯ w ཁ݅ΛܕΞϊςʔγϣϯʹؚΊΔʕʕཁ݅Ξϊςʔγϣϯʹ͢Δ͜ͱͰ ߦͷίʔ υ͔ΒಡΈखʹΘΔҙਤ͕Α Γ๛͔ʹͳΔ w ͜Ε·Ͱͷ+BWB4DSJQU͔Β5ZQF4DSJQUͷաظͩͬͨ w
͜Ε͔Βίʔ υ͕5ZQF4DSJQUͱͯ͠ɺ 5ZQF4DSJQUΒ͘͠ख़͍ͯ࣌͘͠ w 5ZQF4DSJQUͱ ͯ͠Α Γ๛͔ͳදݱΛ͢ΔͳΒ தͷͳ͍ΞϊςʔγϣϯΑ Γதͷ͋ΔΞϊςʔγϣϯΛ৺͕͚ΔͱΑ͍