{"id":19580845,"url":"https://github.com/orcid/orcidsearchurljs","last_synced_at":"2026-02-01T19:33:06.808Z","repository":{"id":20646919,"uuid":"23928911","full_name":"ORCID/orcidSearchUrlJs","owner":"ORCID","description":"Javascript library that builds a search URL for the ORCID public API.","archived":false,"fork":false,"pushed_at":"2016-05-23T12:53:21.000Z","size":1560,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-05-12T13:53:05.757Z","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":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ORCID.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-09-11T17:45:15.000Z","updated_at":"2024-03-12T12:38:40.000Z","dependencies_parsed_at":"2022-08-24T07:21:06.924Z","dependency_job_id":null,"html_url":"https://github.com/ORCID/orcidSearchUrlJs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ORCID/orcidSearchUrlJs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ORCID%2ForcidSearchUrlJs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ORCID%2ForcidSearchUrlJs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ORCID%2ForcidSearchUrlJs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ORCID%2ForcidSearchUrlJs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ORCID","download_url":"https://codeload.github.com/ORCID/orcidSearchUrlJs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ORCID%2ForcidSearchUrlJs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260252137,"owners_count":22981196,"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","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-11T07:30:17.507Z","updated_at":"2026-02-01T19:33:06.773Z","avatar_url":"https://github.com/ORCID.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"orcidSearchUrl.js\n=================\n\nJavascript library that builds a search URL for the ORCID public API.\n\n## Functions\n\n* buildUrl(input) Takes a JSON object defining the search, and returns the URL to use in the API.\n\nThe input JSON object can have the following properties.\n\n\u003ctable\u003e\n    \u003ctr\u003e\n        \u003cth\u003eProperty\u003c/th\u003e\n        \u003cth\u003eDescription\u003c/th\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003etext\u003c/td\u003e\n        \u003ctd\u003eThe text for a quick search across all fields. Can also be an ORCID iD, in which case only the iD field will be searched.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003egivenNames\u003c/td\u003e\n        \u003ctd\u003eText to search across the given-names field.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003esearchOtherNames\u003c/td\u003e\n        \u003ctd\u003eBoolean to determine whether to search for givenNames in the other-names field. Default is false.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003efamilyName\u003c/td\u003e\n        \u003ctd\u003eText to search across the family-name field.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003ekeyword\u003c/td\u003e\n        \u003ctd\u003eText to search across the keyword field.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003estart\u003c/td\u003e\n        \u003ctd\u003eThe row to start the results from (for paging). Default is 0 (the first row).\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003erows\u003c/td\u003e\n        \u003ctd\u003eThe maximum number of results to return.\u003c/td\u003e\n    \u003c/tr\u003e\n\u003c/table\u003e\n\nSee orcidSearchUrlSpec.js for examples.\n\n* setBaseUrl(url) Sets the base URL to use. The default is 'https://orcid.org/v1.1/search/orcid-bio/'.\n\n* isValidInput(input) Returns true only if there is some input to search with.\n\n* isValidOrcidId(orcidId) Returns true only if orcidId contains a valid looking ORCID iD URI or path. \nAllows preceding and trailing whitespace.\n\n\n## Using in a browser\nInclude orcidSearchUrl.js and call ``orcidSearchUrlJs.buildUrl({ text: 'my search terms'})``.\n\n\n## Using in [Node.js](http://nodejs.org/)\n1. Install\n    \n    npm install orcid-search-url-js\n    \n2. Require the module\n\n    var orcidSearchUrl = require('orcid-search-url-js');\n    \n3. Call\n\n    orcidSearchUrlJs.buildUrl({ text: 'my search terms'});\n\n   \n## Contributing\n\nContributions are welcome.\n\nPlease make sure the unit tests (orcidSearchUrlSpec.js) reflect the changes and complete successfully. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forcid%2Forcidsearchurljs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Forcid%2Forcidsearchurljs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forcid%2Forcidsearchurljs/lists"}