{"id":22021470,"url":"https://github.com/lamansky/3fn","last_synced_at":"2026-04-15T07:34:39.538Z","repository":{"id":57093089,"uuid":"144318367","full_name":"lamansky/3fn","owner":"lamansky","description":"[Node.js] Three-Way Comparison Function. Creates a callback that compares two objects by one or more keys.","archived":false,"fork":false,"pushed_at":"2018-08-10T18:12:22.000Z","size":3,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-09T05:13:44.696Z","etag":null,"topics":[],"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/lamansky.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-10T18:09:36.000Z","updated_at":"2018-08-10T18:12:23.000Z","dependencies_parsed_at":"2022-08-22T18:20:27.683Z","dependency_job_id":null,"html_url":"https://github.com/lamansky/3fn","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/lamansky/3fn","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lamansky%2F3fn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lamansky%2F3fn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lamansky%2F3fn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lamansky%2F3fn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lamansky","download_url":"https://codeload.github.com/lamansky/3fn/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lamansky%2F3fn/sbom","scorecard":{"id":577703,"data":{"date":"2025-08-11","repo":{"name":"github.com/lamansky/3fn","commit":"b6a35bc7587552cf3c8b88657cc368f906f91460"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"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":"Dangerous-Workflow","score":-1,"reason":"no workflows found","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":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"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":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Code-Review","score":0,"reason":"Found 0/1 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":"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":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"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":"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":"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":"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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: license.txt:0","Info: FSF or OSI recognized license: MIT License: license.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"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 'master'"],"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"}}]},"last_synced_at":"2025-08-20T18:17:18.671Z","repository_id":57093089,"created_at":"2025-08-20T18:17:18.671Z","updated_at":"2025-08-20T18:17:18.671Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31831844,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-15T07:17:56.427Z","status":"ssl_error","status_checked_at":"2026-04-15T07:17:30.007Z","response_time":63,"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":[],"created_at":"2024-11-30T06:12:13.003Z","updated_at":"2026-04-15T07:34:39.517Z","avatar_url":"https://github.com/lamansky.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Three-Way Comparison Function (3fn)\n\nCreates a callback that compares two objects by one or more keys.\n\n## Installation\n\nRequires [Node.js](https://nodejs.org/) 8.3.0 or above.\n\n```bash\nnpm i 3fn\n```\n\n## API\n\nThe module exports a single function.\n\n### Parameters\n\n1. Variadic/Optional: `sortBy` (function, array, or any): A Map/object key. An array will be interpreted as a chain of nested keys. A function will be interpreted as a three-way comparison callback that accepts two arguments and returns a number. If the key is user-provided, you should wrap it in an array; otherwise you’ll have problems if the key is a function, array, or plain object.\n2. Optional: `options` (plain object): An argument passed to the [3](https://github.com/lamansky/3) and [kget](https://github.com/lamansky/kget) modules, allowing you to set their options. The most commonly-needed option is `inObj`, which must be set to `true` if `sortBy` is a key which points to an _inherited_ object property.\n\n### Return Value\n\nA callback function that accepts a Map, Object, or other collection as its argument and returns `-1`, `0`, or `1`. This callback then can be passed to the `sort` function of an Array, for example.\n\n## Examples\n\n### Compare By Key\n\n```javascript\nconst threeFn = require('3fn')\n\nconst personA = {name: 'John'}\nconst personB = {name: 'Andrew'}\n\nconst compare = threeFn('name')\n\ncompare(personA, personB) // 1\ncompare(personB, personA) // -1\n\n[personA, personB].sort(compare) // [personB, personA]\n```\n\n### Compare By Inherited Key\n\n```javascript\nconst threeFn = require('3fn')\n\nconst _name = Symbol('name')\n\nclass Person {\n  constructor (name) {\n    this[_name] = name\n  }\n\n  get name () {\n    return this[_name]\n  }\n}\n\nconst personA = new Person('John')\nconst personB = new Person('Andrew')\n\nconst compare = threeFn('name', {inObj: true})\n\ncompare(personA, personB) // 1\ncompare(personB, personA) // -1\n\n[personA, personB].sort(compare) // [personB, personA]\n```\n\n### Compare By Multiple Keys\n\n```javascript\nconst threeFn = require('3fn')\n\nconst personA = {name: 'John', age: 46}\nconst personB = {name: 'John', age: 27}\n\nconst compare = threeFn('name', 'age') // Sort by name first, and by age second\n\ncompare(personA, personB) // 1\ncompare(personB, personA) // -1\n\n[personA, personB].sort(compare) // [personB, personA]\n```\n\n### Compare By Nested Keys\n\n```javascript\nconst threeFn = require('3fn')\n\nconst personA = {name: {first: 'John'}}\nconst personB = {name: {first: 'Andrew'}}\n\nconst compare = threeFn(['name', 'first'])\n\ncompare(personA, personB) // 1\ncompare(personB, personA) // -1\n\n[personA, personB].sort(compare) // [personB, personA]\n```\n\n## Related\n\nThis module is based on [3](https://github.com/lamansky/3), the three-way comparison module.\n\nIt is also part of the `fn` family of modules:\n\n* [efn](https://github.com/lamansky/efn): Extracted Function\n* [ffn](https://github.com/lamansky/ffn): Filtering Function\n* [jfn](https://github.com/lamansky/jfn): Joined Function\n* [mfn](https://github.com/lamansky/mfn): Memoized Function\n* [ofn](https://github.com/lamansky/ofn): Overloaded Function\n* [pfn](https://github.com/lamansky/pfn): Possible Function\n* [qfn](https://github.com/lamansky/qfn): Qualified Function\n* [vfn](https://github.com/lamansky/vfn): Variadic Function\n* [wfn](https://github.com/lamansky/wfn): Wrapper Function\n* [xfn](https://github.com/lamansky/xfn): Extended Function\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flamansky%2F3fn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flamansky%2F3fn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flamansky%2F3fn/lists"}