{"_id":"@creditkarma/ttwitter-client-filter","_rev":"1-e6dd8fc2baa3ad300a762c805bf6770e","name":"@creditkarma/ttwitter-client-filter","dist-tags":{"next":"0.11.0-alpha.0","latest":"0.11.0-alpha.0"},"versions":{"0.11.0-alpha.0":{"name":"@creditkarma/ttwitter-client-filter","version":"0.11.0-alpha.0","description":"Express server middleware for the Apache Thrift protocol","main":"dist/main/index.js","types":"dist/main/index.d.ts","keywords":[],"scripts":{"clean":"npm run clean-dist && npm run clean-gen","clean-dist":"rimraf ./dist","clean-gen":"rimraf ./src/ttwitter","lint":"tslint --fix './src/**/*.ts'","format":"prettier --write 'src/**/*.ts'","precodegen":"npm run clean-gen","codegen":"thrift-typescript --target thrift-server --rootDir ./src --sourceDir ./thrift --outDir ./ttwitter","prebuild":"npm run clean && npm run lint && npm run format && npm run codegen","build":"tsc","test":"npm run test:only","test:only":"echo 'No tests for ttwitter-client-filter'; exit 0;"},"dependencies":{"zipkin":"^0.14.3"},"peerDependencies":{"@creditkarma/thrift-client":"0.10.x","@creditkarma/thrift-context-filter":"0.10.x","@creditkarma/thrift-server-core":"0.10.x","@creditkarma/thrift-zipkin-core":"0.10.x"},"devDependencies":{"@creditkarma/thrift-client":"^0.11.0-alpha.0","@creditkarma/thrift-context-filter":"^0.11.0-alpha.0","@creditkarma/thrift-server-core":"^0.11.0-alpha.0","@creditkarma/thrift-typescript":"^3.0.3-0","@creditkarma/thrift-zipkin-core":"^0.11.0-alpha.0","@types/node":"^8.10.38","prettier":"^1.15.1","rimraf":"^2.6.2","tslint":"^5.11.0","tslint-config-prettier":"^1.15.0","tslint-plugin-prettier":"^2.0.0","typescript":"3.1.x"},"_id":"@creditkarma/ttwitter-client-filter@0.11.0-alpha.0","_npmVersion":"5.6.0","_nodeVersion":"8.9.4","_npmUser":{"name":"hightimesteddy","email":"hightimesteddy@gmail.com"},"dist":{"integrity":"sha512-pgQha5DjesyAijFusmjW5UmHaas4ZvWX/xYy5c7ySrTcOsq2OFGMJ4zV6eRl5HsnrKOmN7rKYFf82V00pmJY0Q==","shasum":"ffb7af072d52b046f822a7f341bad0ccf08c6554","tarball":"https://registry.npmjs.org/@creditkarma/ttwitter-client-filter/-/ttwitter-client-filter-0.11.0-alpha.0.tgz","fileCount":12,"unpackedSize":28981,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcAKckCRA9TVsSAnZWagAAIgQP/37NzQ5eVD+MUzB1dzhb\ncdhfmzc/MPnhjH6DUaEX+qpn0JTHsLtD3QzwLk3VkYRFDKIoXS+3NdDdoyu6\n+aSIEQMhiJG3p1seGC/pD3VepHgHbdH3sVdkiFwUjvA5Ws5mpUUxLt0fsb0w\nxJODCUOyceIu3q+pjkNcyJe+0UAge2RquFg4Txr6cIg2cleN5cm2Ezd3O0RT\nV0ejK8DwnXTKyK3aJqhbgDeUTaUFkPTfaejKJGP9rvP/Mk+I20Cnf3sfj3Ke\nHTDbDFQHaBRLHhiXJH7p0O4uz5aldyPSLOFI8QonNSpyzbKtYt3kCeOFcbi1\nZ0UTHhelnZ5z4GhQrCi6/1lUQYuqqlw01VMFJxYrgA3t//x0CvhZDayYcYWv\nz5uChsPP/5GcyhwaO8+p7xdkHsCMmZDSjVgh1PWKtyD3wT557w3xTjw9AVt2\nMmlegrCHvoTVE/e79Ha+kXxe8bovVdpCtU6pwySEHuh1bR4IAPix+ieUnvoX\nOIuqfgmUqOzC28d8KQ/FBGQRZcLR7nQ6SZHYMmNeLmetVKGySEQ25XM7G4rL\nF7txkCVwsi7RE0E3WwA7qn7JWwyw+ea2kA2orSlvlyUQt8dP/3dIBSARdCDI\nsWdS1q6bo4Ecp8ayokbI0Cniu9heTmagWEwR959Xj2JkfME9hj1L3yUoTzpH\noOTP\r\n=tfva\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDYfkfej4w7ymkF0S7JArmGiPrMBIia5ocqUBw++Eb4ggIgSZI95E3s1Y2jJknNXn2qEL358FNCkYpc0imJhc4YjmM="}]},"maintainers":[{"name":"ouranosskia","email":"UGAPiro@gmail.com"},{"name":"ck-npm","email":"pie@creditkarma.com"},{"name":"hightimesteddy","email":"hightimesteddy@gmail.com"},{"name":"nnanceck","email":"nick.nance@creditkarma.com"},{"name":"wookiehangover","email":"samuel.breed@gmail.com"},{"name":"riley-stroud-ck","email":"riley.stroud@creditkarma.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ttwitter-client-filter_0.11.0-alpha.0_1543546659610_0.09048000138033152"},"_hasShrinkwrap":false}},"time":{"created":"2018-11-30T02:57:39.541Z","0.11.0-alpha.0":"2018-11-30T02:57:39.735Z","modified":"2022-04-05T01:46:05.284Z"},"maintainers":[{"name":"ouranosskia","email":"UGAPiro@gmail.com"},{"name":"ck-npm","email":"pie@creditkarma.com"},{"name":"hightimesteddy","email":"hightimesteddy@gmail.com"},{"name":"nnanceck","email":"nick.nance@creditkarma.com"},{"name":"wookiehangover","email":"samuel.breed@gmail.com"},{"name":"riley-stroud-ck","email":"riley.stroud@creditkarma.com"}],"description":"Express server middleware for the Apache Thrift protocol","keywords":[],"readme":"# TTwitterClientFilter\n\nThis plugin can be used in conjuction with Twitter's open source [Finagle](https://github.com/twitter/finagle) project to add and receive the headers that project expects.\n\n## Installation\n\n`TTwitterClientFilter` has a few `peerDependencies`.\n\n```sh\nnpm install --save @creditkarma/thrift-server-core\nnpm install --save @creditkarma/thrift-client\nnpm install --save @creditkarma/thrift-context-filter\nnpm install --save @creditkarma/ttwitter-client-filter\n```\n\n## Usage\n\n```typescript\nimport {\n    createTcpClient,\n} from '@creditkarma/thrift-client'\n\nimport {\n    TTwitterClientFilter,\n} from '@creditkarma/ttwitter-client-filter'\n\nimport {\n    Calculator,\n} from './codegen/calculator'\n\nconst thriftClient: Calculator.Client<RequestContext> =\n    createTcpClient(Calculator.Client, {\n        hostName: 'localhost',\n        port: 8080,\n        register: [ TTwitterClientFilter({\n            localServiceName: 'calculator-client',\n            remoteServiceName: 'calculator-service',\n            destHeader: 'calculator-service',\n            endpoint: 'http://localhost:9411/api/v1/spans',\n            sampleRate: 1,\n        }) ]\n    })\n\nthriftClient.add(5, 6).then((response: number) => {\n    // Do stuff...\n})\n```\n\n*Note: The Twitter types are generated and exported under the name `TTwitter`*\n\n## Options\n\nAvailable options for TTwitterClientFilter:\n\n* localServiceName (required): The name of your local service/application.\n* remoteServiceName (required): The name of the remote service you are calling.\n* destHeader (optional): A name for the destination added to the RequestHeader object Finagle expects. Defaults to the value of `remoteServiceName`.\n* isUpgraded (optional): Is the service using TTwitter context. Defaults to true.\n* clientId (optional): A unique identifier for the client. Defaults to undefined.\n* transportType (optional): The type of transport to use. Currently only 'buffered'.\n* protocolType (optional): The type of protocol to use. Currently only 'binary'.\n* tracerConfig.debug (optional): Zipkin debug mode. Defaults to false.\n* tracerConfig.endpoint (optional): Zipkin endpoint. Defaults to ''.\n* tracerConfig.sampleRate (optional): Zipkin samplerate. Defaults to 0.1.\n* tracerConfig.httpInterval (optional): Rate (in milliseconds) at which to send traces to Zipkin collector. Defaults to 1000.\n\n## Contributing\n\nFor more information about contributing new features and bug fixes, see our [Contribution Guidelines](../../CONTRIBUTING.md).\nExternal contributors must sign Contributor License Agreement (CLA)\n\n## License\n\nThis project is licensed under [Apache License Version 2.0](./LICENSE)\n","readmeFilename":"README.md"}