{"id":15699090,"url":"https://github.com/numminorihsf/json-pokemon","last_synced_at":"2025-05-09T02:24:02.513Z","repository":{"id":41443340,"uuid":"166330714","full_name":"NumminorihSF/json-pokemon","owner":"NumminorihSF","description":"Package with pokemons","archived":false,"fork":false,"pushed_at":"2019-01-18T02:50:07.000Z","size":12,"stargazers_count":6,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-26T11:03:35.367Z","etag":null,"topics":["pokemon"],"latest_commit_sha":null,"homepage":null,"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/NumminorihSF.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":"2019-01-18T02:32:10.000Z","updated_at":"2023-03-24T09:43:19.000Z","dependencies_parsed_at":"2022-09-26T16:21:17.764Z","dependency_job_id":null,"html_url":"https://github.com/NumminorihSF/json-pokemon","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NumminorihSF%2Fjson-pokemon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NumminorihSF%2Fjson-pokemon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NumminorihSF%2Fjson-pokemon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NumminorihSF%2Fjson-pokemon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NumminorihSF","download_url":"https://codeload.github.com/NumminorihSF/json-pokemon/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243141268,"owners_count":20242815,"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":["pokemon"],"created_at":"2024-10-03T19:38:16.430Z","updated_at":"2025-03-12T01:38:12.357Z","avatar_url":"https://github.com/NumminorihSF.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# json-pokemon\n\nThis package includes list of all pokemons. Original data is available on \u003chttps://pokemondb.net/pokedex/national\u003e.\n\n## Install\n\nTo install this package use\n\n```bash\nnpm install --save json-pokemon\n```\n\n## Usage\n\n`require` command just returns a list of pokemon objects. The format is next:\n\n```js\nconst pokemons = require('json-pokemon');\n\nconst pokemon = pokemons[0];\n// pokemon's structure:\n// {\n//   id: 1,\n//   name: 'some-pokemon-name',\n//   typeList: ['Fire', 'Grass']\n// }\n```\n\n## Possible usage\n\n```js\nconst getPokemons = require('json-pokemon/getPokemon');\n\nconst pokemons = getPokemons(); // See API in the next section.\nconst firstPokemon = getPokemons.getPokemonById(1); // See API in the next section.\nconst snow = getPokemons.getPokemonByName('snow'); // See API in the next section.\n```\n\n## API\n\n\u003c!-- Generated by documentation.js. Update this documentation by updating the source code. --\u003e\n\n#### Table of Contents\n\n-   [Pokemon](#pokemon)\n    -   [Properties](#properties)\n-   [getPokemonById](#getpokemonbyid)\n    -   [Parameters](#parameters)\n-   [getPokemonByName](#getpokemonbyname)\n    -   [Parameters](#parameters-1)\n-   [getPokemon](#getpokemon)\n    -   [Parameters](#parameters-2)\n\n### Pokemon\n\nPokemon's type.\n\nType: [object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)\n\n#### Properties\n\n-   `id` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Pokemon's id.\n-   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Pokemon's name.\n-   `typeList` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\u0026lt;[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)\u003e** Pokemon's types.\n\n### getPokemonById\n\nReturns pokemon found by its id.\n\n#### Parameters\n\n-   `id` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Pokemon's id.\n\nReturns **([Pokemon](#pokemon) | null)** Pokemon if founded, else returns null.\n\n### getPokemonByName\n\nReturns pokemon found by its name.\n\n#### Parameters\n\n-   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Pokemon's id.\n\nReturns **([Pokemon](#pokemon) | null)** Pokemon if founded, else returns null.\n\n### getPokemon\n\nReturns list of pokemons filtered with passed info.\n\n#### Parameters\n\n-   `filter` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Filter descriptor. (optional, default `{}`)\n    -   `filter.type` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\u0026lt;[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)\u003e | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | null)** Types of pokemons to returns.\n        If type is `null`, skip this filter. If type is string, returns list of pokemons which has this type.\n        If type is an array, returns list of pokemons which has all of types. (optional, default `null`)\n\nReturns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\u0026lt;[Pokemon](#pokemon)\u003e** List of filtered pokemons.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnumminorihsf%2Fjson-pokemon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnumminorihsf%2Fjson-pokemon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnumminorihsf%2Fjson-pokemon/lists"}