{"id":13342872,"url":"https://github.com/oleiade/xk6-random","last_synced_at":"2026-06-06T11:31:42.071Z","repository":{"id":218397303,"uuid":"746309241","full_name":"oleiade/xk6-random","owner":"oleiade","description":"A k6 extension providing advanced random number generation capabilities","archived":false,"fork":false,"pushed_at":"2024-01-21T18:09:16.000Z","size":18,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-19T21:40:20.599Z","etag":null,"topics":["go","k6","k6-extension","random","xk6"],"latest_commit_sha":null,"homepage":"","language":"Go","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/oleiade.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,"governance":null,"roadmap":null,"authors":null}},"created_at":"2024-01-21T17:27:55.000Z","updated_at":"2024-01-22T08:42:36.000Z","dependencies_parsed_at":"2024-01-21T18:44:41.734Z","dependency_job_id":null,"html_url":"https://github.com/oleiade/xk6-random","commit_stats":null,"previous_names":["oleiade/xk6-random"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/oleiade/xk6-random","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oleiade%2Fxk6-random","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oleiade%2Fxk6-random/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oleiade%2Fxk6-random/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oleiade%2Fxk6-random/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oleiade","download_url":"https://codeload.github.com/oleiade/xk6-random/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oleiade%2Fxk6-random/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33981122,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-06T02:00:07.033Z","response_time":107,"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":["go","k6","k6-extension","random","xk6"],"created_at":"2024-07-29T19:30:06.458Z","updated_at":"2026-06-06T11:31:42.056Z","avatar_url":"https://github.com/oleiade.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# xk6-random\n\nxk6-random is an extension for [k6](https://k6.io), providing advanced random number generation capabilities.\nIt supports various distributions, array shuffling, and picking random elements from arrays.\n\n```javascript\nimport { shuffle, Random } from 'k6/x/random';\n\nexport default function () {\n    // Create a new Random generator\n    let rng = new Random();\n\n    // Shuffle an array\n    let colors = ['red', 'green', 'blue', 'yellow'];\n    shuffle(colors);\n    console.log(colors);\n\n    // Pick a random element from an array\n    let pick = rng.pick(colors);\n    console.log(`picked color: ${pick}`);\n    \n    // Generate a random integer between 1 and 10\n    let int = rng.intBetween(1, 10);\n    console.log(`random integer: ${int}`);\n}\n```\n\n## Features\n\n* Generation of random integers and floating-point numbers.\n* Support for different distributions: uniform, normal (Gaussian), log-normal, Bernoulli, binomial, geometric, and exponential.\n* Functions to shuffle arrays, generate random permutations, and pick random elements (including weighted picking).\n\n## Installation\n\nTo build a k6 binary with the xk6-random extension, first ensure you have the prerequisites:\n\n* Go installed (version 1.17 or later).\n* Git installed.\n\nThen, install xk6:\n\n```bash\ngo install go.k6.io/xk6/cmd/xk6@latest\n```\n\nBuild the binary with the xk6-random extension:\n\n```bash\nxk6 build --with github.com/oleiade/xk6-random@latest\n```\n\n## Usage\n\nAfter building the k6 binary with the xk6-random extension, you can use it in your k6 scripts:\n\n```javascript\nimport {shuffle, Random} from 'k6/x/random';\n\n// Example usage\nexport default function () {\n    // Create a new Random generator\n    let rng = new Random();\n\n    // Generate a random integer\n    console.log(rng.int());\n\n    // Generate a random float\n    console.log(rng.float());\n\n    // Generate a random boolean\n    console.log(rng.boolean());\n\n    // Generate a random number from a normal distribution\n    console.log(rng.normal(0, 1));\n\n    // Shuffle an array\n    let array = [1, 2, 3, 4, 5];\n    shuffle(array);\n    console.log(array);\n}\n```\n\n## API Reference\n\n### Random Generator \n\nThe `Random` class provides the following methods for generating random numbers.\n\nIt supports a default constructor which will use the current time as a seed, or a constructor which takes a seed as an argument.\n\n```javascript\nimport { Random } from 'k6/x/random';\n\nexport default function() {\n    // Create a new Random generator with a seed\n    let rng = new Random(1234);\n    let int = rng.int();\n    console.log(int);\n}\n```\n\nArmed with your random generator, you can use the following methods to generate random numbers.\n\n#### `Random.int()`\n\nReturns a random integer.\n\n```javascript\nimport { Random } from 'k6/x/random';\n\nexport default function() {\n    let rng = new Random();\n    let int = rng.int();\n    console.log(int);\n}\n```\n\n#### `Random.float()`\n\nReturns a random real number.\n\n```javascript\nimport { Random } from 'k6/x/random';\n\nexport default function() {\n    let rng = new Random();\n    let float = rng.float();\n    console.log(float);\n}\n```\n\n#### `Random.boolean()`\n\nReturns a random boolean value.\n\n```javascript\nimport { Random } from 'k6/x/random';\n\nexport default function() {\n    let rng = new Random();\n    let bool = rng.boolean();\n    console.log(bool);\n}\n```\n\n#### `Random.intBetween(min, max)`\n\nReturns a random integer between min and max.\n\n```javascript\nimport { Random } from 'k6/x/random';\n\nexport default function() {\n    let rng = new Random();\n    let int = rng.intBetween(1, 10);\n    console.log(int);\n}\n```\n\n#### `Random.floatBetween(min, max)`\n\nReturns a random real number between min and max.\n\n```javascript\nimport { Random } from 'k6/x/random';\n\nexport default function() {\n    let rng = new Random();\n    let float = rng.floatBetween(1, 10);\n    console.log(float);\n}\n```\n\n#### `Random.pick(array)`\n\nReturns a random element from the given array.\n\n```javascript\nimport { Random } from 'k6/x/random';\n\nexport default function() {\n    let rng = new Random();\n    let array = [1, 2, 3, 4, 5];\n    let pick = rng.pick(array);\n    console.log(pick);\n}\n```\n\n#### `Random.weightedPick(array, weights)`\n\nReturns a random element from the given array, based on the given weights.\n\n```javascript\nimport { Random } from 'k6/x/random';\n\nexport default function() {\n    let rng = new Random();\n    let array = [1, 2, 3, 4, 5];\n    let weights = [0.1, 0.2, 0.3, 0.2, 0.2];\n    let pick = rng.weightedPick(array, weights);\n    console.log(pick);\n}\n```\n\n#### `Random.normal(mean, stdev)`\n\nReturns a random real number from a normal distribution.\n\n```javascript\nimport { Random } from 'k6/x/random';\n\nexport default function() {\n    let rng = new Random();\n    let normal = rng.normal(0, 1);\n    console.log(normal);\n}\n```\n\n#### `Random.logNormal(mean, stdev)`\n\nReturns a random real number from a log-normal distribution.\n\n```javascript\nimport { Random } from 'k6/x/random';\n\nexport default function() {\n    let rng = new Random();\n    let logNormal = rng.logNormal(0, 1);\n    console.log(logNormal);\n}\n```\n\n#### `Random.bernoulli(probability)`\n\nReturns a random boolean value with the given probability.\n\n```javascript\nimport { Random } from 'k6/x/random';\n\nexport default function() {\n    let rng = new Random();\n    let bernoulli = rng.bernoulli(0.5);\n    console.log(bernoulli);\n}\n```\n\n#### `Random.binomial(trials, probability)`\n\nReturns a random integer from a binomial distribution.\n\n```javascript\nimport { Random } from 'k6/x/random';\n\nexport default function() {\n    let rng = new Random();\n    let binomial = rng.binomial(10, 0.5);\n    console.log(binomial);\n}\n```\n\n#### `Random.geometric(probability)`\n\nReturns a random integer from a geometric distribution.\n\n```javascript\nimport { Random } from 'k6/x/random';\n\nexport default function() {\n    let rng = new Random();\n    let geometric = rng.geometric(0.5);\n    console.log(geometric);\n}\n```\n\n#### `Random.exponential(rate)`\n\nReturns a random real number from an exponential distribution.\n\n```javascript\nimport { Random } from 'k6/x/random';\n\nexport default function() {\n    let rng = new Random();\n    let exponential = rng.exponential(0.5);\n    console.log(exponential);\n}\n```\n\n### Top-level Functions\n\nTop-level functions are also provided for convenience:\n\n#### `permutation(n)`\n\nReturns a random permutation of the integers [0, n).\n\n```javascript\nimport { permutation } from 'k6/x/random';\n\nexport default function() {\n    let perm = permutation(10);\n    console.log(perm);\n}\n```\n\n#### `shuffle(array)`\n\nShuffles the given array in-place.\n\n```javascript\nimport { shuffle } from 'k6/x/random';\n\nexport default function() {\n    let array = [1, 2, 3, 4, 5];\n    shuffle(array);\n    console.log(array);\n}\n```\n\n#### `shuffled(array)`\n\nReturns a shuffled copy of the given array.\n\n```javascript\nimport { shuffled } from 'k6/x/random';\n\nexport default function() {\n    let array = [1, 2, 3, 4, 5];\n    let shuffledArray = shuffled(array);\n    console.log(shuffledArray);\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foleiade%2Fxk6-random","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foleiade%2Fxk6-random","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foleiade%2Fxk6-random/lists"}