├── .editorconfig ├── .gitattributes ├── .github └── workflows │ └── main.yml ├── .gitignore ├── .npmrc ├── index.d.ts ├── index.js ├── index.test-d.ts ├── license ├── package.json ├── readme.md └── test.js /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = tab 5 | end_of_line = lf 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.yml] 11 | indent_style = space 12 | indent_size = 2 13 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | test: 7 | name: Node.js ${{ matrix.node-version }} 8 | runs-on: ubuntu-latest 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | node-version: 13 | - 20 14 | - 18 15 | steps: 16 | - uses: actions/checkout@v4 17 | - uses: actions/setup-node@v4 18 | with: 19 | node-version: ${{ matrix.node-version }} 20 | - run: npm install 21 | - run: npm test 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | yarn.lock 3 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /index.d.ts: -------------------------------------------------------------------------------- 1 | /** 2 | Get a random key from an object. 3 | 4 | @example 5 | ``` 6 | import randomObjectKey from 'random-object-key'; 7 | 8 | randomObjKey({foo: true, bar: true}); 9 | //=> 'bar' 10 | ``` 11 | */ 12 | export default function randomObjectKey>(object: ObjectType): keyof ObjectType; 13 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | export default function randomObjectKey(object) { 2 | const keys = Object.keys(object); 3 | return keys[Math.floor(Math.random() * keys.length)]; 4 | } 5 | -------------------------------------------------------------------------------- /index.test-d.ts: -------------------------------------------------------------------------------- 1 | import {expectType} from 'tsd'; 2 | import randomObjectKey from './index.js'; 3 | 4 | expectType<'foo' | 'bar'>(randomObjectKey({foo: true, bar: true})); 5 | -------------------------------------------------------------------------------- /license: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) Sindre Sorhus (https://sindresorhus.com) 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 6 | 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 8 | 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "random-object-key", 3 | "version": "4.0.0", 4 | "description": "Get a random key from an object", 5 | "license": "MIT", 6 | "repository": "sindresorhus/random-object-key", 7 | "funding": "https://github.com/sponsors/sindresorhus", 8 | "author": { 9 | "name": "Sindre Sorhus", 10 | "email": "sindresorhus@gmail.com", 11 | "url": "https://sindresorhus.com" 12 | }, 13 | "type": "module", 14 | "exports": { 15 | "types": "./index.d.ts", 16 | "default": "./index.js" 17 | }, 18 | "sideEffects": false, 19 | "engines": { 20 | "node": ">=18" 21 | }, 22 | "scripts": { 23 | "test": "xo && ava && tsd" 24 | }, 25 | "files": [ 26 | "index.js", 27 | "index.d.ts" 28 | ], 29 | "keywords": [ 30 | "random", 31 | "randomize", 32 | "math", 33 | "object", 34 | "key", 35 | "pick", 36 | "select", 37 | "choice" 38 | ], 39 | "devDependencies": { 40 | "ava": "^6.1.2", 41 | "stable-function": "^4.0.0", 42 | "tsd": "^0.31.0", 43 | "xo": "^0.58.0" 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # random-object-key 2 | 3 | > Get a random key from an object 4 | 5 | ## Install 6 | 7 | ```sh 8 | npm install random-object-key 9 | ``` 10 | 11 | ## Usage 12 | 13 | ```js 14 | import randomObjectKey from 'random-object-key'; 15 | 16 | randomObjectKey({foo: true, bar: true}); 17 | //=> 'bar' 18 | ``` 19 | 20 | ## Related 21 | 22 | - [random-object-value](https://github.com/sindresorhus/random-object-value) - Get a random value from an object 23 | - [random-int](https://github.com/sindresorhus/random-int) - Generate a random integer 24 | - [random-float](https://github.com/sindresorhus/random-float) - Generate a random float 25 | - [random-item](https://github.com/sindresorhus/random-item) - Get a random item from an array 26 | - [unique-random](https://github.com/sindresorhus/unique-random) - Generate random numbers that are consecutively unique 27 | - [unique-random-array](https://github.com/sindresorhus/unique-random-array) - Get consecutively unique elements from an array 28 | - [crypto-random-string](https://github.com/sindresorhus/crypto-random-string) - Generate a cryptographically strong random string 29 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import test from 'ava'; 2 | import stableFunction from 'stable-function'; 3 | import randomObjectKey from './index.js'; 4 | 5 | const fixture = { 6 | a: true, 7 | b: true, 8 | c: true, 9 | d: true, 10 | e: true, 11 | }; 12 | 13 | test('main', t => { 14 | t.false(stableFunction(() => randomObjectKey(fixture))); 15 | 16 | for (let index = 0; index < 1000; index++) { 17 | t.is(typeof randomObjectKey(fixture), 'string'); 18 | } 19 | }); 20 | --------------------------------------------------------------------------------