{"id":17419923,"url":"https://github.com/bendrucker/submission","last_synced_at":"2025-07-23T12:34:44.317Z","repository":{"id":57240328,"uuid":"42545745","full_name":"bendrucker/submission","owner":"bendrucker","description":"Observable interface for managing submission states","archived":false,"fork":false,"pushed_at":"2019-08-19T21:56:08.000Z","size":11,"stargazers_count":4,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-14T07:17:44.065Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/bendrucker.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-09-15T20:49:27.000Z","updated_at":"2019-07-12T17:10:30.000Z","dependencies_parsed_at":"2022-08-29T22:21:19.797Z","dependency_job_id":null,"html_url":"https://github.com/bendrucker/submission","commit_stats":null,"previous_names":["bendrucker/form-submit-state"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/bendrucker/submission","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bendrucker%2Fsubmission","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bendrucker%2Fsubmission/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bendrucker%2Fsubmission/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bendrucker%2Fsubmission/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bendrucker","download_url":"https://codeload.github.com/bendrucker/submission/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bendrucker%2Fsubmission/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266680295,"owners_count":23967791,"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","status":"online","status_checked_at":"2025-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"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-10-17T02:36:29.814Z","updated_at":"2025-07-23T12:34:44.293Z","avatar_url":"https://github.com/bendrucker.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# submission [![Build Status](https://travis-ci.org/bendrucker/submission.svg?branch=master)](https://travis-ci.org/bendrucker/submission) [![Greenkeeper badge](https://badges.greenkeeper.io/bendrucker/submission.svg)](https://greenkeeper.io/)\n\n\u003e Observable interface for managing submission submission states\n\n\n## Install\n\n```\n$ npm install --save submission\n```\n\n\n## Usage\n\n```js\nvar Submission = require('submission')\nvar submission = Submission()\n\nsubmission.pending()\n//=\u003e false\n\nsubmission.error()\n//=\u003e null\n\nSubmission.submit(submission, function (callback) {\n  //=\u003e submission.pending() === true\n  submit(callback)\n})\n\nfunction submit (callback) {\n  //=\u003e submit data to server\n  //=\u003e call callback w/ err, data\n}\n\nSubmission.onData(submission, console.log)\n//=\u003e data\n\nSubmission.onError(submission, console.log)\n//=\u003e null / Error\n```\n\n## API\n\n#### `Submission([data])` -\u003e `function`\n\nReturns an observable submission state.\n\n##### data\n\nType: `object`\nDefault: `{pending: false, error: null}`\n\nThe initial submission state.\n\n#### `Submission.submit(state, fn)` -\u003e `undefined`\n\n##### state\n\n*Required*  \nType: `function`\n\nA submission state observable.\n\n##### fn\n\n*Required*  \nType: `function`  \nArguments: `callback`\n\nA function to call to trigger submission. The function will receive a callback that will update the submission state and trigger events based on the result.\n\n#### `Submission.onData(state, listener)` -\u003e `function`\n\nReturns a function that removes the event listener.\n\n##### state\n\n*Required*  \nType: `function`\n\nA submission state observable.\n\n##### listener\n\n*Required*  \nType: `function`\n\nA function to be called with the submission data passed back from the function provided to `Submission.submit`.\n\n#### `Submission.onError(state, listener)` -\u003e `function`\n\nReturns a function that removes the event listener.\n\n##### state\n\n*Required*  \nType: `function`\n\nA submission state observable.\n\n##### listener\n\n*Required*  \nType: `function`\n\nA function to be called with an error passed back from the function provided to `Submission.submit`.\n\n## License\n\nMIT © [Ben Drucker](http://bendrucker.me)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbendrucker%2Fsubmission","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbendrucker%2Fsubmission","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbendrucker%2Fsubmission/lists"}