{"id":15364447,"url":"https://github.com/xadillax/chinese-random-name","last_synced_at":"2025-04-08T07:33:04.930Z","repository":{"id":19907718,"uuid":"23173194","full_name":"XadillaX/chinese-random-name","owner":"XadillaX","description":":u55b6: Generate Chinese name using Node.js.","archived":false,"fork":false,"pushed_at":"2024-10-03T21:09:54.000Z","size":227,"stargazers_count":265,"open_issues_count":2,"forks_count":26,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-01T05:33:38.191Z","etag":null,"topics":["chinese-name","nodejs"],"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/XadillaX.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"XadillaX","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2014-08-21T03:41:36.000Z","updated_at":"2024-08-09T05:32:07.000Z","dependencies_parsed_at":"2024-06-18T17:00:45.007Z","dependency_job_id":"bc4a909d-9778-464f-8ca7-e035c50a8a23","html_url":"https://github.com/XadillaX/chinese-random-name","commit_stats":{"total_commits":46,"total_committers":5,"mean_commits":9.2,"dds":0.5,"last_synced_commit":"be80a1afe49e6a376626c803c4b1e31079be406d"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XadillaX%2Fchinese-random-name","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XadillaX%2Fchinese-random-name/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XadillaX%2Fchinese-random-name/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XadillaX%2Fchinese-random-name/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/XadillaX","download_url":"https://codeload.github.com/XadillaX/chinese-random-name/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247796320,"owners_count":20997550,"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":["chinese-name","nodejs"],"created_at":"2024-10-01T13:11:46.293Z","updated_at":"2025-04-08T07:33:04.899Z","avatar_url":"https://github.com/XadillaX.png","language":"JavaScript","funding_links":["https://github.com/sponsors/XadillaX"],"categories":[],"sub_categories":[],"readme":"# Chinese Random Name\n\nGenerate Chinese name by using Node.js with ❤️.\n\n## Installation\n\n```sh\n$ npm --save install chinese-random-name\n```\n\n## Usage\n\nFirst you need to require this package:\n\n```javascript\nconst randomName = require('chinese-random-name');\n```\n\n\u003e **If you're using it from Browser environment, do require\n\u003e `chinese-random-name/random.min`.**\n\n### Generate a Full Name Automatically\n\nUse `generate()` function:\n\n```javascript\nconsole.log(randomName.generate());\n```\n\n### Only Surname\n\nUse `getOne` function in `surnames`.\n\n```javascript\nconsole.log(randomName.surnames.getOne());\n```\n\n`getOne` has an optional parameter `opt`. You may pass a field named\n`useSurnamesCountAtTheTop` to specify only get surname from most top\n`useSurnamesCountAtTheTop` surnames. e.g.\n\n```javascript\nrandomName.surnames.getOne({ useSurnamesCountAtTheTop: 100 });\n```\n\nIt means the function only select a random surname from the most top 100\nsurnames.\n\n### Name\n\nUse `get` / `get1` / `get2` / `get3` function in `names`.\n\n+ `get`: returns a random name and its length between 1 and 3.\n+ `get1`: returns a random name with length 1. (you can pass a parameter which may be `\"金\"` / `\"木\"` / `\"水\"` / `\"火\"` / `\"土\"` or leave it blank)\n+ `get2`: returns a random name with length 2. (you can pass `\"金金\"` / `\"金木\"` / ... or leave it blank)\n+ `get3`: returns a random name with length 3. (you can pass `\"金金金\"` / `\"水火土\"` / ... or leave it blank)\n+ `dict`: the dictionary object.\n\nExamples:\n\n```javascript\nrandomName.names.get();\nrandomName.names.get1();\nrandomName.names.get2();\nrandomName.names.get3();\nrandomName.names.get1(\"金\");\nrandomName.names.get2(\"木水\");\nrandomName.names.get3(\"火火火\");\n```\n\n## Related Article\n\nhttp://xcoder.in/2014/09/01/how-i-made-chinese-random-x/\n\n## Contribute\n\nYou're welcome to fork and make pull requests!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxadillax%2Fchinese-random-name","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxadillax%2Fchinese-random-name","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxadillax%2Fchinese-random-name/lists"}