{"id":25687070,"url":"https://github.com/holyshared/zip-code-stream","last_synced_at":"2025-07-26T23:36:12.459Z","repository":{"id":57406059,"uuid":"55456019","full_name":"holyshared/zip-code-stream","owner":"holyshared","description":"The zip code stream for japanese","archived":false,"fork":false,"pushed_at":"2016-08-24T06:59:08.000Z","size":1656,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-17T13:45:20.095Z","etag":null,"topics":["csv","jp","nodejs","stream","zip-code"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/holyshared.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-04-05T00:45:52.000Z","updated_at":"2017-04-21T07:21:14.000Z","dependencies_parsed_at":"2022-09-11T23:21:29.837Z","dependency_job_id":null,"html_url":"https://github.com/holyshared/zip-code-stream","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/holyshared%2Fzip-code-stream","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/holyshared%2Fzip-code-stream/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/holyshared%2Fzip-code-stream/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/holyshared%2Fzip-code-stream/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/holyshared","download_url":"https://codeload.github.com/holyshared/zip-code-stream/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240549396,"owners_count":19819139,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["csv","jp","nodejs","stream","zip-code"],"created_at":"2025-02-24T20:08:05.061Z","updated_at":"2025-02-24T20:08:05.766Z","avatar_url":"https://github.com/holyshared.png","language":"JavaScript","readme":"# zip-code-jp-stream\n\n[![npm version](https://badge.fury.io/js/zip-code-jp-stream.svg)](https://badge.fury.io/js/zip-code-jp-stream)\n[![Build Status](https://travis-ci.org/holyshared/zip-code-stream.svg?branch=master)](https://travis-ci.org/holyshared/zip-code-stream)\n[![Dependency Status](https://david-dm.org/holyshared/zip-code-stream.svg)](https://david-dm.org/holyshared/zip-code-stream)\n\nIt provides a stream for reading the data of the japanese postal code.\n\n## Basic usage\n\nThis module supports the stream of CSV / ZIP format.\n\n### Stream of ZIP file\n\nBy using the **createFromZipFile**, it can be read the data from the ZIP format of the file.\n\n```js\nconst stream = require('zip-code-jp-stream'); \nconst reader = stream.createFromZipFile('../ken_all.zip');\n\nreader.on('data', (r) =\u003e {\n  console.log(r); // CSV record object\n});\n\nreader.on('end', () =\u003e {\n  console.log('end');\n});\n```\n\n### Stream of CSV file\n\nYou can generate the CSV of the stream.\n\n```js\nconst stream = require('zip-code-jp-stream'); \nconst reader = stream.createFromCSVFile('../ken_all.csv');\n\nreader.on('data', (r) =\u003e {\n  console.log(r); // CSV record object\n});\n\nreader.on('end', () =\u003e {\n  console.log('end');\n});\n```\n\n\n\n## Object format\n\nFormat of the object that will be called from the stream is as follows.  \nFor the string, it has been converted from Shift_JIS to UTF8.\n\n|プロパティ|説明|\n|:------------|:------------|\n|jis_code|全国地方公共団体コード（JIS X0401、X0402）|\n|legacy_zip_code|（旧）郵便番号（5桁）|\n|zip_code|郵便番号（7桁）|\n|prefecture_kana|都道府県名|\n|city_kana|市区町村名|\n|area_kana|町域名|\n|prefecture|都道府県名|\n|city|市区町村名|\n|area|町域名|\n|tow_zip_code_display|一町域が二以上の郵便番号で表される場合の表示|\n|number_of_address_display|小字毎に番地が起番されている町域の表示 （注4）　（「1」は該当、「0」は該当せず）|\n|city_block_display|丁目を有する町域の場合の表示　（「1」は該当、「0」は該当せず）|\n|one_zip_code_display|一つの郵便番号で二以上の町域を表す場合の表示　（注5）　（「1」は該当、「0」は該当せず）|\n|changed_status|更新の表示（注6）（「0」は変更なし、「1」は変更あり、「2」廃止（廃止データのみ使用））|\n|changed_reason|変更理由　（「0」は変更なし、「1」市政・区政・町政・分区・政令指定都市施行、「2」住居表示の実施、「3」区画整理、「4」郵便区調整等、「5」訂正、「6」廃止（廃止データのみ使用））|\n\n## Execution of the test\n\n1. install node modules\n\n\t\tnpm install\n\n2. running the test\n\n\t\tnpm test\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fholyshared%2Fzip-code-stream","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fholyshared%2Fzip-code-stream","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fholyshared%2Fzip-code-stream/lists"}