yubin 0.1.3 → 0.2.0

package/dist/index.d.cts

@@ -0,0 +1,55 @@
+/** 標準郵便番号データ（ken_all.csv 由来） */
+type KenAllAddress = {
+    source: "ken_all";
+    postalCode: string;
+    oldPostalCode: string;
+    jisCode: string;
+    prefecture: string;
+    prefectureKana: string;
+    city: string;
+    cityKana: string;
+    town: string;
+    townKana: string;
+    multiPostalCode: boolean;
+    koazabanchi: boolean;
+    chome: boolean;
+    multiTown: boolean;
+};
+/** 事業所個別郵便番号データ（JIGYOSYO.CSV 由来） */
+type JigyosyoAddress = {
+    source: "jigyosyo";
+    postalCode: string;
+    oldPostalCode: string;
+    jisCode: string;
+    prefecture: string;
+    city: string;
+    town: string;
+    streetAddress: string;
+    companyName: string;
+    companyNameKana: string;
+    postOffice: string;
+    codeType: 0 | 1;
+};
+type Address = KenAllAddress | JigyosyoAddress;
+
+/**
+ * 郵便番号から住所情報を取得する。
+ *
+ * @param postalCode - 郵便番号（ハイフンあり/なし両対応、全角数字対応）
+ * @returns 住所情報。見つからない場合は null。同一郵便番号が両データに存在する場合は事業所データを優先。
+ */
+declare function getAddress(postalCode: string): Address | null;
+
+/**
+ * 郵便番号を正規化する。
+ * - 前後空白除去
+ * - 〒 除去
+ * - ハイフン類除去（-, －, ー, ‐, −）
+ * - 全角数字→半角変換
+ *
+ * @returns 正規化された7桁の郵便番号文字列、または不正な場合 null
+ */
+declare function normalizePostalCode(input: string): string | null;
+
+export { getAddress, normalizePostalCode };
+export type { Address, JigyosyoAddress, KenAllAddress };

package/dist/index.d.mts

@@ -0,0 +1,55 @@
+/** 標準郵便番号データ（ken_all.csv 由来） */
+type KenAllAddress = {
+    source: "ken_all";
+    postalCode: string;
+    oldPostalCode: string;
+    jisCode: string;
+    prefecture: string;
+    prefectureKana: string;
+    city: string;
+    cityKana: string;
+    town: string;
+    townKana: string;
+    multiPostalCode: boolean;
+    koazabanchi: boolean;
+    chome: boolean;
+    multiTown: boolean;
+};
+/** 事業所個別郵便番号データ（JIGYOSYO.CSV 由来） */
+type JigyosyoAddress = {
+    source: "jigyosyo";
+    postalCode: string;
+    oldPostalCode: string;
+    jisCode: string;
+    prefecture: string;
+    city: string;
+    town: string;
+    streetAddress: string;
+    companyName: string;
+    companyNameKana: string;
+    postOffice: string;
+    codeType: 0 | 1;
+};
+type Address = KenAllAddress | JigyosyoAddress;
+
+/**
+ * 郵便番号から住所情報を取得する。
+ *
+ * @param postalCode - 郵便番号（ハイフンあり/なし両対応、全角数字対応）
+ * @returns 住所情報。見つからない場合は null。同一郵便番号が両データに存在する場合は事業所データを優先。
+ */
+declare function getAddress(postalCode: string): Address | null;
+
+/**
+ * 郵便番号を正規化する。
+ * - 前後空白除去
+ * - 〒 除去
+ * - ハイフン類除去（-, －, ー, ‐, −）
+ * - 全角数字→半角変換
+ *
+ * @returns 正規化された7桁の郵便番号文字列、または不正な場合 null
+ */
+declare function normalizePostalCode(input: string): string | null;
+
+export { getAddress, normalizePostalCode };
+export type { Address, JigyosyoAddress, KenAllAddress };

package/dist/index.d.ts

@@ -0,0 +1,55 @@
+/** 標準郵便番号データ（ken_all.csv 由来） */
+type KenAllAddress = {
+    source: "ken_all";
+    postalCode: string;
+    oldPostalCode: string;
+    jisCode: string;
+    prefecture: string;
+    prefectureKana: string;
+    city: string;
+    cityKana: string;
+    town: string;
+    townKana: string;
+    multiPostalCode: boolean;
+    koazabanchi: boolean;
+    chome: boolean;
+    multiTown: boolean;
+};
+/** 事業所個別郵便番号データ（JIGYOSYO.CSV 由来） */
+type JigyosyoAddress = {
+    source: "jigyosyo";
+    postalCode: string;
+    oldPostalCode: string;
+    jisCode: string;
+    prefecture: string;
+    city: string;
+    town: string;
+    streetAddress: string;
+    companyName: string;
+    companyNameKana: string;
+    postOffice: string;
+    codeType: 0 | 1;
+};
+type Address = KenAllAddress | JigyosyoAddress;
+
+/**
+ * 郵便番号から住所情報を取得する。
+ *
+ * @param postalCode - 郵便番号（ハイフンあり/なし両対応、全角数字対応）
+ * @returns 住所情報。見つからない場合は null。同一郵便番号が両データに存在する場合は事業所データを優先。
+ */
+declare function getAddress(postalCode: string): Address | null;
+
+/**
+ * 郵便番号を正規化する。
+ * - 前後空白除去
+ * - 〒 除去
+ * - ハイフン類除去（-, －, ー, ‐, −）
+ * - 全角数字→半角変換
+ *
+ * @returns 正規化された7桁の郵便番号文字列、または不正な場合 null
+ */
+declare function normalizePostalCode(input: string): string | null;
+
+export { getAddress, normalizePostalCode };
+export type { Address, JigyosyoAddress, KenAllAddress };