{"id":16406971,"url":"https://github.com/d-koppenhagen/webfinger","last_synced_at":"2025-04-04T14:41:06.353Z","repository":{"id":81667511,"uuid":"94250951","full_name":"d-koppenhagen/webfinger","owner":"d-koppenhagen","description":"A webfinger client written in TypeScript","archived":false,"fork":false,"pushed_at":"2020-07-15T23:20:31.000Z","size":1188,"stargazers_count":3,"open_issues_count":6,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-10T00:25:30.672Z","etag":null,"topics":["client","identity","javascript","library","typescript","webfinger"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/d-koppenhagen.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"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":"2017-06-13T19:43:04.000Z","updated_at":"2024-08-24T18:29:01.000Z","dependencies_parsed_at":null,"dependency_job_id":"d9d0aecd-a785-44c5-aa44-db5ca38056cd","html_url":"https://github.com/d-koppenhagen/webfinger","commit_stats":{"total_commits":24,"total_committers":2,"mean_commits":12.0,"dds":0.04166666666666663,"last_synced_commit":"9c7fb3f5d0e2b09e68271ac9289ccf069d80b786"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/d-koppenhagen%2Fwebfinger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/d-koppenhagen%2Fwebfinger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/d-koppenhagen%2Fwebfinger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/d-koppenhagen%2Fwebfinger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/d-koppenhagen","download_url":"https://codeload.github.com/d-koppenhagen/webfinger/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247198404,"owners_count":20900078,"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":["client","identity","javascript","library","typescript","webfinger"],"created_at":"2024-10-11T06:11:40.041Z","updated_at":"2025-04-04T14:41:06.336Z","avatar_url":"https://github.com/d-koppenhagen.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# webfinger-client\n[![NPM version][npm-image]][npm-url]\n\nA webfinger client that runs both in the browser and in node.js.\nThe Client is based on Nick Jennings library [webfinger.js](https://github.com/silverbucket/webfinger.js) but has been rewritten in TypeScript.\n\n## Demo\nCheck out the Demo at GitHub Pages: [https://d-koppenhagen.github.io/webfinger/](https://d-koppenhagen.github.io/webfinger/)\n\n\n## Features\n* defaults to TLS only\n* optional URI fallback (for older services which use `host-meta` or `host-meta.json` URI endpoints)\n* optional support for [WebFist](http://webfist.org)\n\n## Demo\nclone this repository, run `npm install` and finally `npm start`\n\n## Install\nInstall the client as a dependency:\n\n```bash\nnpm install --save webfinger-client\n```\n\n## Usage\n### Import\nYou have to import the module before using it:\n\n```typescript\nimport { WebFinger } from 'webfinger';\n```\n\n### Use\n```typescript\n  let webfinger = new WebFinger({\n    webfistFallback: true,  // defaults to false\n    tlsOnly: true,          // defaults to true\n    uriFallback: false,     // defaults to false\n    requestTimeout: 10000,  // defaults to 10000\n  });\n\n  webfinger.lookup('alice@example.org', function (err, p) {\n    if (err) {\n      console.log('error: ', err.message);\n    } else {\n      console.log(p);\n    }\n  });\n\n\n// example output:\n// {\n//   idx: {\n//     properties: {\n//       name: \"Alice Henderson\"\n//     },\n//     links: {\n//       avatar: [{ href: '\u003curl\u003e' }],\n//       blog: [{ href: '\u003curl\u003e' }],\n//       vcard: [href: '\u003curl' }]\n//       ... etc.\n//     },\n//   }\n//   json: { ... raw json output ... }\n//   object: { ... unformatted but parsed into native javascript object ... }\n// }\n\n  webfinger.lookupLink('alice@example.org', 'remotestorage' function (err, p) {\n    if (err) {\n      console.log('error: ', err.message);\n    } else {\n      console.log(p);\n    }\n  });\n\n// example output (if at least one link with rel=\"remotestorage\" exists):\n// {\n//   href: 'https://storage.5apps.com/alice',\n//   rel : 'remotestorage',\n//   properties: {\n//     'http://remotestorage.io/spec/version': 'draft-dejong-remotestorage-02',\n//     'http://tools.ietf.org/html/rfc6749#section-4.2': 'https://5apps.com/rs/oauth/alice',\n//     'http://tools.ietf.org/html/rfc6750#section-2.3': false,\n//     'http://tools.ietf.org/html/rfc2616#section-14.16': false\n//   }\n// }\n```\n\n## Development\nThe library is built with Webpack. Notes for building and serving can be fount in \n[DEVELOPMENT](DEVELOPMENT).\n\n[npm-url]: https://npmjs.org/package/webfinger-client\n[npm-image]: https://badge.fury.io/js/webfinger-client.svg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fd-koppenhagen%2Fwebfinger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fd-koppenhagen%2Fwebfinger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fd-koppenhagen%2Fwebfinger/lists"}