#14 TypeScriptで学ぶ外部ライブラリの基本

TypeScriptの外部ライブラリは、JavaScriptと同じnpmを使いますが、型情報の扱いに注意が必要です。この記事では、TypeScriptにおける外部ライブラリの使い方の基本と、型定義ファイルの仕組みを解説します。

npmでライブラリをインストールする

npm install axios

インストールしたライブラリの情報は、package.jsonという設定ファイルに自動的に記録されます。

型定義ファイルという仕組み

TypeScriptでライブラリの機能を安全に使うには、そのライブラリの「型定義ファイル」(.d.tsという拡張子のファイル)が必要です。ライブラリによっては、最初から型定義が同梱されていることもあれば、別途インストールが必要なこともあります。

npm install --save-dev @types/lodash

@types/から始まるパッケージは、型情報だけを提供する専用のライブラリです。--save-devを付けるのは、型定義は開発中のチェックにのみ必要で、実際に動くアプリには不要な情報だからです。

ライブラリを使う

import axios from 'axios';

axios.get('https://example.com').then(response => {
    console.log(response.status);
});

型定義があるライブラリでは、response.まで入力した時点で、エディタが利用可能なプロパティ(statusやdataなど)を候補として表示してくれます。

型定義が無いライブラリを使う場合

どうしても型定義が用意されていないライブラリを使う必要がある場合、自分で最小限の型を宣言する方法もあります。

declare module 'some-untyped-library' {
    export function doSomething(input: string): void;
}

ただし、この方法は宣言した型が実際のライブラリの動作と食い違うリスクもあるため、まずは@types/パッケージが存在しないか、npmで検索して確認するのが先決です。

TypeScriptならではの注意点

型定義が用意されていないライブラリを使おうとすると、エラーになったり、型のチェックが効かなくなったりすることがあります。ライブラリを選ぶ際は、TypeScript対応(型定義の有無)も確認するとよいでしょう。人気のあるライブラリほど公式で型定義を同梱している傾向にあるため、選定時の判断材料の1つにもなります。

まとめ

TypeScriptの外部ライブラリはJavaScriptと同じnpmで導入しますが、型定義ファイル(@types/を含む)の有無を意識することが重要です。

本ページはプロモーションを含みます。

参考書籍(PR)

TypeScriptをもっと学びたい方には「プロを目指す人のためのTypeScript入門」がおすすめです。

PR

コードを書かずに自動化したい方へ

「学んだけど自分の作業に組み込む時間がない」という方向けに、ダブルクリックで動く Windows専用の自動化ツールをオーダーメイドで作成しています。気になる方は こちらをご覧ください。

コメント

コメントを投稿

このブログの人気の投稿

#25 Rustで学ぶAI API(ChatGPT等)の呼び出し方の基本

ChatGPTのようなAI(人工知能)の機能を自分のアプリに組み込みたいとき、多くの場合は「AI API」と呼ばれる仕組みを使います。APIとは「Application Programming Interface」の略です。簡単に言えば、「あるサービスの機能を、プログラムから呼び出せるようにした窓口」のことです。この記事では、Rustから外部のAI APIをHTTPリクエストで呼び出す基本的な流れを、初心者向けに解説します。 AI APIを呼び出すとはどういうことか ChatGPTを提供するOpenAI社などは、インターネット経由でAIに質問を送り、回答を受け取れる「AI API」を公開しています。これはWebブラウザで検索するときのように、決まった宛先(URL)にデータを送信し、返ってきた結果を受け取る仕組みです。この「データを送って結果を受け取る」通信方式を、HTTPリクエストと呼びます。Rustのプログラムからこの通信を行うことで、自分のアプリの中でAIに質問し、回答を取得できるようになります。 reqwestクレートを使う Rustには標準でHTTP通信の機能は含まれていません。そこで使うのが「クレート」と呼ばれる外部ライブラリです。クレートはPythonのライブラリやJavaScriptのパッケージに近いもので、 Cargo.toml というファイルに追記するだけで簡単に導入できます。HTTP通信でよく使われるのが reqwest というクレートです。 Cargo.toml に次のように追記します(バージョン番号は執筆時点の例なので、実際に使う際は最新版を確認してください)。 [dependencies] reqwest = { version = "0.11", features = ["json"] } tokio = { version = "1", features = ["full"] } serde_json = "1.0" ここで tokio という見慣れないクレートも一緒に入れています。これは「非同期処理」と呼ばれる、通信の待ち時間の間に他の処理を進められる仕組みを扱うためのものです。ネットワーク通信は結果が返ってくるまで時間...
続きを読む

#8 C++で学ぶ文字列操作の基本

C++の文字列操作は、`std::string`という型を使うのが現代的な基本の書き方です。この記事では、C++における文字列操作の基本と、注意しておきたい落とし穴を解説します。 文字列を連結する std::string greeting = "こんにちは、" + name + "さん"; `std::string`同士であれば、`+`を使った連結がそのまま使えます。既存の文字列に追加する場合は`+=`や`append`メソッドも使えます。 greeting += "。よろしくお願いします。"; よく使う文字列操作 name.length() 文字数を調べる(バイト数であることに注意、後述) name.substr(0, 3) 一部分を取り出す(開始位置と長さを指定) name.find("A") 特定の文字の位置を探す(見つからなければ`std::string::npos`) name.replace(0, 2, "XX") 一部分を置き換える 文字列を数値に変換する 文字列を数値に変換したい場合は`std::stoi`(整数)や`std::stod`(小数)、逆に数値を文字列にしたい場合は`std::to_string`を使います。 int num = std::stoi("123"); std::string s = std::to_string(456); 文字列を分割する C++の標準ライブラリには、他言語の`split`のような文字列分割の関数が長らく用意されていませんでした。`std::stringstream`を使うのが伝統的な方法です。 #include <sstream> std::stringstream ss("a,b,c"); std::string item; while (std::getline(ss, item, ',')) { std::cout << item << std::endl; } C++ならではの注意点 C++には、古くからある`char`の配列を...
続きを読む

#16 TypeScriptで学ぶ辞書型(マップ)の基本

TypeScriptの辞書に相当する仕組みは、JavaScriptと同じですが、キーと値の型をあらかじめ決めておけるのが特徴です。この記事では、TypeScriptにおける辞書の扱い方と、用途別の型の選び方を解説します。 型付きのオブジェクト interface Person { name: string; age: number; } const person: Person = { name: "太郎", age: 20 }; キーの型が決まっていない辞書 キーの名前が事前に決まっていない辞書のような使い方をしたい場合は、次のように書きます。 const scores: { [key: string]: number } = {}; scores["太郎"] = 90; 同じ意味を Record というユーティリティ型で簡潔に書くこともできます。 const scores: Record = {}; Mapを使う場合 const person = new Map (); person.set("name", "太郎"); console.log(person.get("name")); Map<string, string> のように、キーと値それぞれの型を指定できます。 Object と違い、キーの数を person.size で正確に取得できる、キーの型を文字列以外にもできるといった利点があります。 値が存在しないかもしれない場合 キーが実在するとは限らない辞書の場合、値の型に | undefined を含めておくと、より正確な型になります。 const scores: { [key: string]: number | undefined } = {}; const value = scores["三郎"]; // number | undefined 型 こうしておくと、存在しないキーへのアクセスがコンパイル時に見過ごされにくくなります。 存在しないキーへのアクセスを防ぐ tsconfig.json で noUncheckedIndexedAccess を有効にす...
続きを読む