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

cra-z

v1.1.4

Published

A tool for generating and querying Chinese region addresses, including provinces, cities, and districts.

Downloads

19

Readme

CRA (Chinese Region Address)

CRA is a Node.js and Vue.js compatible library that provides functionalities for generating and querying Chinese region addresses, including provinces, cities, and districts.

简体中文

Features

  • Get Address by Code or Name: Retrieve the full address information by providing either the administrative code or name.
  • Random Address Generation: Generate a random province, city, or district-level address.
  • Hierarchy Lookup: Find the hierarchical relationship of a region by its code or name, supporting both single and multiple queries.
  • Fuzzy Name Matching: Perform fuzzy matching to find regions that closely match a given name.
  • Tree Structure Export: Export the entire tree structure of provinces, cities, and districts based on a given province code.
  • Modular Design: Easily extendable and maintainable codebase, following best practices.

Installation

Install the package using npm:

npm install cra-z

Usage

In a Node.js Project

const cra = require('cra-z');

// Get Address by Name
const addressByName = cra.findByName('北京市');
console.log('Address found by name:', addressByName);

// Get Hierarchy by Code
const hierarchyByCode = cra.findHierarchy('350200');
console.log('Hierarchy found by code:', hierarchyByCode);

// Fuzzy Match by Name
const fuzzyResults = cra.fuzzyMatchByName('柳州');
console.log('Fuzzy match results:', fuzzyResults);

// Export Tree by Province Code
const tree = cra.exportTreeByProvinceCode('350000');
console.log('Tree structure:', tree);

In a Vue.js Project

import cra from 'cra-z';

// Use similar methods as in Node.js
const addressByName = cra.findByName('厦门市');
console.log('Address found by name:', addressByName);

TypeScript Support

The library includes TypeScript type definitions. You can use it directly in a TypeScript project.

Contributing

Contributions are welcome! Please follow the standard coding guidelines and ensure all tests pass before submitting a pull request.

License

See the LICENSE file for details.