npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@toriyama/japanese-address-parser

v0.2.0-rc.3

Published

A library for processing addresses of Japan

Downloads

172

Readme

@toriyama/japanese-address-parser

A Library for processing addresses of Japan written in Rust.

npmjs install size downloads

Install

Install with npm:

npm install @toriyama/japanese-address-parser

Install with yarn:

yarn add @toriyama/japanese-address-parser

Introduction

@toriyama/japanese-address-parser is a library for parsing Japanese addresses.
You can split an address string into prefectures(都道府県), municipalities(市区町村), towns and villages(町村), and each subsequent element.

This library is a JavaScript binding for japanese-address-parser crate written in Rust by using wasm-pack. Node.js is not yet supported. If you are eager to use this library on Node.js, please write comments on #128 or pull-request!

Demo

You can try it out on the demo pages below.

  • https://yuukitoriyama.github.io/japanese-address-parser/public/index.html
  • https://yuukitoriyama.github.io/japanese-address-parser/public/nightly.html (include experimental feature)

Example

import init, {Parser} from "@toriyama/japanese-address-parser"

init().then(() => {
    const parser = new Parser()
    parser.parse("東京都千代田区丸ノ内1-1-1").then(parseResult => {
        console.log(JSON.stringify(parseResult, null, "\t"))
    })
})
{
  "address": {
    "prefecture": "東京都",
    "city": "千代田区",
    "town": "丸の内一丁目",
    "rest": "1-1"
  }
}

How it works

The input string is basically read in order from the beginning to the end. Once the name of prefecture has been scanned, the names of city will be scanned, then the names of town, and so on.
We don't have the list of city names or town names in this library, but fetch them via the internet each time. Version 0.1 use Geolonia住所データ authored by Geolonia Inc.
Detection place names may fail in some cases, such as when there is a notation distortion or when county names are omitted. In such cases, this library tries fuzzy match instead of exact match.

For more details, please visit our repository.

Contributing

If you want to contribute this library, please read the contribution guide to learn how to propose bug fixes and improvements.

License

This library is distributed under the terms of the MIT license.

Related projects