{"id":18349138,"url":"https://github.com/fonoster/sipp-js","last_synced_at":"2026-03-07T05:32:17.167Z","repository":{"id":57361904,"uuid":"282324998","full_name":"fonoster/sipp-js","owner":"fonoster","description":"A Javascript wrapper for SIPp","archived":false,"fork":false,"pushed_at":"2023-10-18T03:02:04.000Z","size":441,"stargazers_count":7,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-27T10:34:43.017Z","etag":null,"topics":["signaling","sip","testing"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/fonoster.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"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}},"created_at":"2020-07-24T22:11:21.000Z","updated_at":"2025-09-14T06:57:01.000Z","dependencies_parsed_at":"2025-04-06T09:42:03.767Z","dependency_job_id":null,"html_url":"https://github.com/fonoster/sipp-js","commit_stats":null,"previous_names":["psanders/sipua"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/fonoster/sipp-js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fonoster%2Fsipp-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fonoster%2Fsipp-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fonoster%2Fsipp-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fonoster%2Fsipp-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fonoster","download_url":"https://codeload.github.com/fonoster/sipp-js/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fonoster%2Fsipp-js/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30208731,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-07T05:23:27.321Z","status":"ssl_error","status_checked_at":"2026-03-07T05:00:17.256Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["signaling","sip","testing"],"created_at":"2024-11-05T21:20:44.806Z","updated_at":"2026-03-07T05:32:17.119Z","avatar_url":"https://github.com/fonoster.png","language":"TypeScript","funding_links":[],"categories":["Testing"],"sub_categories":["GPS, Time"],"readme":"\u003ca name=\"SIPP\"\u003e\u003c/a\u003e\n\n## SIPP\nsipp-js is a wrapper for sipp. The purpose of this library is to simplify the\ncreation of SIPp instances. It is not intended to be a full SIPp implementation.\n\n\u003e This library requires the sipp executable to be installed on the system.\n\n**Kind**: global class  \n\n* [SIPP](#SIPP)\n    * [new SIPP(options)](#new_SIPP_new)\n    * [.setUsername(username)](#SIPP+setUsername) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\n    * [.setPassword(password)](#SIPP+setPassword) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\n    * [.withScenario(scenarioFile)](#SIPP+withScenario) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\n    * [.withReportFreq(frequency)](#SIPP+withReportFreq) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\n    * [.withTraceStat()](#SIPP+withTraceStat) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\n    * [.withTraceScreen()](#SIPP+withTraceScreen) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\n    * [.withTransportMode(transportMode)](#SIPP+withTransportMode) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\n    * [.withInf(info)](#SIPP+withInf) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\n    * [.setInfIndex(info, index)](#SIPP+setInfIndex) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\n    * [.setVariable(variable, value)](#SIPP+setVariable) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\n    * [.withStats(fileName)](#SIPP+withStats) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\n    * [.withCallRate(rate)](#SIPP+withCallRate) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\n    * [.withCallLimit(limit)](#SIPP+withCallLimit) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\n    * [.withCallRateIncrease(rate, time)](#SIPP+withCallRateIncrease) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\n    * [.withCallMax(calls)](#SIPP+withCallMax) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\n    * [.withOpt(key, parameter)](#SIPP+withOpt) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\n    * [.withTimeout(timeout)](#SIPP+withTimeout) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\n    * [.build()](#SIPP+build) ⇒ \u003ccode\u003estring\u003c/code\u003e\n    * [.start()](#SIPP+start) ⇒ \u003ccode\u003ePromise.\u0026lt;Buffer\u0026gt;\u003c/code\u003e\n    * [.startAsync(callback)](#SIPP+startAsync) ⇒ \u003ccode\u003eChildProcess\u003c/code\u003e\n    * [.stop()](#SIPP+stop)\n\n\u003ca name=\"new_SIPP_new\"\u003e\u003c/a\u003e\n\n### new SIPP(options)\nConstructs a new SIPP object.\n\n\n| Param | Type | Description |\n| --- | --- | --- |\n| options | \u003ccode\u003eSIPPOptions\u003c/code\u003e | Configuration object for SIPP |\n| options.remoteHost | \u003ccode\u003estring\u003c/code\u003e | Remote host to connect to |\n| options.localPort | \u003ccode\u003enumber\u003c/code\u003e | Local port to use for SIP signaling |\n| options.timeout | \u003ccode\u003enumber\u003c/code\u003e | Timeout in milliseconds to quit SIPp. Defaults to 30 seconds. |\n\n**Example**  \n```js\nconst SIPP = require(\"sipp-js\");\n\nconst sipp = new SIPP({\n remoteHost: \"remote.host.com\",\n localPort: 5060,\n timeout: 30000\n});\nsipp.setUsername(\"user\");\nsipp.setPassword(\"password\");\nsipp.setScenario(`${process.cwd()}/scenarios/etc/arc.xml`);\nsipp.start();\n\nassert.ok(result.stderr == null)\n```\n\u003ca name=\"SIPP+setUsername\"\u003e\u003c/a\u003e\n\n### sipP.setUsername(username) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\nOptional username for SIP authentication.\n\n**Kind**: instance method of [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| username | \u003ccode\u003estring\u003c/code\u003e | Username for SIP authentication |\n\n\u003ca name=\"SIPP+setPassword\"\u003e\u003c/a\u003e\n\n### sipP.setPassword(password) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\nOptional password for SIP authentication.\n\n**Kind**: instance method of [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| password | \u003ccode\u003estring\u003c/code\u003e | Password for SIP authentication |\n\n\u003ca name=\"SIPP+withScenario\"\u003e\u003c/a\u003e\n\n### sipP.withScenario(scenarioFile) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\nScenario file to use for SIP signaling.\n\n**Kind**: instance method of [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| scenarioFile | \u003ccode\u003estring\u003c/code\u003e | Scenario file to use for SIP signaling |\n\n\u003ca name=\"SIPP+withReportFreq\"\u003e\u003c/a\u003e\n\n### sipP.withReportFreq(frequency) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\nStatistics report frequency.\n\n**Kind**: instance method of [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| frequency | \u003ccode\u003enumber\u003c/code\u003e | Frequency in seconds |\n\n\u003ca name=\"SIPP+withTraceStat\"\u003e\u003c/a\u003e\n\n### sipP.withTraceStat() ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\nDumps all statistics in \u003cscenario_name\u003e_\u003cpid\u003e.csv file.\n\n**Kind**: instance method of [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)  \n\u003ca name=\"SIPP+withTraceScreen\"\u003e\u003c/a\u003e\n\n### sipP.withTraceScreen() ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\nDump statistic screens in the \u003cscenario_name\u003e_\u003cpid\u003e_screens.log file when quitting SIPp.\n\n**Kind**: instance method of [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)  \n\u003ca name=\"SIPP+withTransportMode\"\u003e\u003c/a\u003e\n\n### sipP.withTransportMode(transportMode) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\nSelects the transport mode to use.\n\n**Kind**: instance method of [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| transportMode | \u003ccode\u003eTransportMode\u003c/code\u003e | Transport mode to use |\n\n\u003ca name=\"SIPP+withInf\"\u003e\u003c/a\u003e\n\n### sipP.withInf(info) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\nInject values from an external CSV file during calls into the scenarios.\n\n**Kind**: instance method of [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)  \n**Returns**: [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP) - Also see `setInfIndex`  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| info | \u003ccode\u003estring\u003c/code\u003e | CSV file to use |\n\n\u003ca name=\"SIPP+setInfIndex\"\u003e\u003c/a\u003e\n\n### sipP.setInfIndex(info, index) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\nCreate an index of file using field.  For example -inf users.csv -infindex\nusers.csv 0 creates an index on the first key.\n\n**Kind**: instance method of [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)  \n**Returns**: [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP) - Also see `withInf`  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| info | \u003ccode\u003estring\u003c/code\u003e | CSV file to use |\n| index | \u003ccode\u003enumber\u003c/code\u003e | Index of CSV file to use |\n\n\u003ca name=\"SIPP+setVariable\"\u003e\u003c/a\u003e\n\n### sipP.setVariable(variable, value) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\nSets a variable to a value. The variable must exist in the scenario.\n\n**Kind**: instance method of [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| variable | \u003ccode\u003estring\u003c/code\u003e | Variable to set |\n| value | \u003ccode\u003estring\u003c/code\u003e | Value to set |\n\n\u003ca name=\"SIPP+withStats\"\u003e\u003c/a\u003e\n\n### sipP.withStats(fileName) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\nSet the file name to use to dump statistics\n\n**Kind**: instance method of [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)  \n**Returns**: [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP) - Also see `withReportFreq`  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| fileName | \u003ccode\u003estring\u003c/code\u003e | File name to use |\n\n\u003ca name=\"SIPP+withCallRate\"\u003e\u003c/a\u003e\n\n### sipP.withCallRate(rate) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\nSet the call rate (in calls per seconds).\n\n**Kind**: instance method of [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| rate | \u003ccode\u003enumber\u003c/code\u003e | Call rate to use |\n\n\u003ca name=\"SIPP+withCallLimit\"\u003e\u003c/a\u003e\n\n### sipP.withCallLimit(limit) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\nSet max simultaneous calls.\n\n**Kind**: instance method of [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)  \n**Returns**: [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP) - Also see `withCallRate`  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| limit | \u003ccode\u003enumber\u003c/code\u003e | Number of calls to make |\n\n\u003ca name=\"SIPP+withCallRateIncrease\"\u003e\u003c/a\u003e\n\n### sipP.withCallRateIncrease(rate, time) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\nSet rate increase (in calls per seconds).\n\n**Kind**: instance method of [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)  \n**Returns**: [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP) - Also see `withCallRate`  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| rate | \u003ccode\u003enumber\u003c/code\u003e | Rate increase to use |\n| time | \u003ccode\u003enumber\u003c/code\u003e | Time to use |\n\n\u003ca name=\"SIPP+withCallMax\"\u003e\u003c/a\u003e\n\n### sipP.withCallMax(calls) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\nSet the number of calls to make.\n\n**Kind**: instance method of [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| calls | \u003ccode\u003enumber\u003c/code\u003e | Number of calls to make |\n\n\u003ca name=\"SIPP+withOpt\"\u003e\u003c/a\u003e\n\n### sipP.withOpt(key, parameter) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\nSets an arbitrary parameter.\n\n**Kind**: instance method of [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| key | \u003ccode\u003estring\u003c/code\u003e | Option to set |\n| parameter | \u003ccode\u003estring\u003c/code\u003e | Value to set |\n\n\u003ca name=\"SIPP+withTimeout\"\u003e\u003c/a\u003e\n\n### sipP.withTimeout(timeout) ⇒ [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)\nSets a timeout to quit SIPp.\n\n**Kind**: instance method of [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| timeout | \u003ccode\u003enumber\u003c/code\u003e | Timeout to use (in seconds) |\n\n\u003ca name=\"SIPP+build\"\u003e\u003c/a\u003e\n\n### sipP.build() ⇒ \u003ccode\u003estring\u003c/code\u003e\nBuilds the command.\n\n**Kind**: instance method of [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)  \n\u003ca name=\"SIPP+start\"\u003e\u003c/a\u003e\n\n### sipP.start() ⇒ \u003ccode\u003ePromise.\u0026lt;Buffer\u0026gt;\u003c/code\u003e\nStarts an instance of SIPp synchronously.\n\n**Kind**: instance method of [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)  \n\u003ca name=\"SIPP+startAsync\"\u003e\u003c/a\u003e\n\n### sipP.startAsync(callback) ⇒ \u003ccode\u003eChildProcess\u003c/code\u003e\nStarts an instance of SIPp asynchronously.\n\n**Kind**: instance method of [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)  \n\n| Param | Type | Description |\n| --- | --- | --- |\n| callback | \u003ccode\u003ecallback\u003c/code\u003e | Callback function |\n\n\u003ca name=\"SIPP+stop\"\u003e\u003c/a\u003e\n\n### sipP.stop()\nStops the instance.\n\n**Kind**: instance method of [\u003ccode\u003eSIPP\u003c/code\u003e](#SIPP)  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffonoster%2Fsipp-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffonoster%2Fsipp-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffonoster%2Fsipp-js/lists"}