{"id":26691408,"url":"https://github.com/itschip/esx.js","last_synced_at":"2025-08-26T03:22:08.821Z","repository":{"id":52809935,"uuid":"313173937","full_name":"itschip/esx.js","owner":"itschip","description":"A JavaScript/TypeScript wrapper for ESX (es_extended) framework in FiveM","archived":false,"fork":false,"pushed_at":"2021-06-14T11:24:14.000Z","size":84,"stargazers_count":6,"open_issues_count":1,"forks_count":5,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-20T06:03:26.464Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/itschip.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-16T02:46:01.000Z","updated_at":"2024-02-26T19:06:25.000Z","dependencies_parsed_at":"2022-09-01T21:51:01.790Z","dependency_job_id":null,"html_url":"https://github.com/itschip/esx.js","commit_stats":null,"previous_names":["derletzteritter/esx.js","itschip/esx.js"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/itschip/esx.js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itschip%2Fesx.js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itschip%2Fesx.js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itschip%2Fesx.js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itschip%2Fesx.js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/itschip","download_url":"https://codeload.github.com/itschip/esx.js/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itschip%2Fesx.js/sbom","scorecard":{"id":497401,"data":{"date":"2025-08-11","repo":{"name":"github.com/itschip/esx.js","commit":"adecbf808d613637fdedf012780827be5fe84162"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.1,"checks":[{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Code-Review","score":0,"reason":"Found 2/28 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/itschip/esx.js/npm-publish.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/itschip/esx.js/npm-publish.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/itschip/esx.js/npm-publish.yml/main?enable=pin","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/npm-publish.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 4 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-19T20:49:19.550Z","repository_id":52809935,"created_at":"2025-08-19T20:49:19.550Z","updated_at":"2025-08-19T20:49:19.550Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272165301,"owners_count":24884680,"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","status":"online","status_checked_at":"2025-08-26T02:00:07.904Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-03-26T16:18:35.795Z","updated_at":"2025-08-26T03:22:08.774Z","avatar_url":"https://github.com/itschip.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# ESX.js\n\u003cdiv style=\"margin: auto 0; width: 100%\"\u003e\n  \u003cimg src=\"https://i.imgur.com/lj2RCGp.jpg\" width=\"300\" height=\"300\"/\u003e\n  \u003cdiv\u003e\n  \u003ca href=\"https://www.npmjs.com/package/esx.js\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/esx.js?style=flat\" alt=\"npm version\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/esx.js\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/dm/esx.js?style=flat\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n## About\n\nThis is a JavaScript/TypeScript wrapper for the ESX (es_extended) framework in FiveM. \n\nIf you experience any issues, please post them in the `Issues`. \n\n## Guide\n\n### `Installation`\n\nRun `npm i esx.js` to install the package. When this is done you are ready to use it. \n\n### `Usage`\n\nSo how do you use it? \n\nFirst you need to import either the `Client` class or `Server` class. \n\n### `Client`\n\n```js\nimport { Client } from 'esx.js'\n\nlet ESX: Client = null\n\nsetImmediate (() =\u003e {\n  emit('esx:getSharedObject', (obj: Client) =\u003e (ESX = obj));\n})\n\n```\n\n### `Server`\n```js\nimport { Server } from 'esx.js'\n\nlet ESX: Server = null\n\nemit('esx:getSharedObject', (obj: Server) =\u003e (ESX = obj));\n```\n\n## You can also import a single type:\n```js\nimport { XPlayer } from 'esx.js/@types/server'\n\nconst Player: XPlayer\n```\n\n### That's it. Now you are ready to rock the world!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitschip%2Fesx.js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitschip%2Fesx.js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitschip%2Fesx.js/lists"}