{"id":13673227,"url":"https://github.com/ameerthehacker/deno-cli-spinners","last_synced_at":"2025-04-12T21:08:40.720Z","repository":{"id":62422154,"uuid":"168942053","full_name":"ameerthehacker/deno-cli-spinners","owner":"ameerthehacker","description":"Awesome deno terminal spinners :art:","archived":false,"fork":false,"pushed_at":"2025-03-18T18:09:26.000Z","size":12,"stargazers_count":60,"open_issues_count":2,"forks_count":7,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-06T22:40:26.521Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/ameerthehacker.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":"2019-02-03T12:19:15.000Z","updated_at":"2025-03-18T18:08:04.000Z","dependencies_parsed_at":"2022-11-01T17:31:28.935Z","dependency_job_id":null,"html_url":"https://github.com/ameerthehacker/deno-cli-spinners","commit_stats":null,"previous_names":["ameerthehacker/cli-spinners"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ameerthehacker%2Fdeno-cli-spinners","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ameerthehacker%2Fdeno-cli-spinners/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ameerthehacker%2Fdeno-cli-spinners/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ameerthehacker%2Fdeno-cli-spinners/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ameerthehacker","download_url":"https://codeload.github.com/ameerthehacker/deno-cli-spinners/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248631676,"owners_count":21136562,"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-08-02T10:00:31.449Z","updated_at":"2025-04-12T21:08:40.674Z","avatar_url":"https://github.com/ameerthehacker.png","language":"TypeScript","funding_links":[],"categories":["Uncategorized","Modules"],"sub_categories":["Uncategorized","CLI utils"],"readme":"# CLI Spinners for Deno\n\n\u003e Awesome deno terminal spinners\n\n![example screenshot](https://i.imgur.com/RBsL1k9.gif)\n\n\u003e This package is inspired from [ora](https://github.com/sindresorhus/ora) and [cli-spinners](https://github.com/sindresorhus/cli-spinners) \n\n## Usage\n\n```typescript\nimport Spinner from 'https://deno.land/x/cli_spinners@v0.0.2/mod.ts';\n\nconst spinner = Spinner.getInstance();\n\nspinner.start('running step 1');\n// Perform long running step 1\nspinner.setText('running step 2');\n// Perform long running step 2\nspinner.stop();\n```\n\n## API\n\n```typescript\nSpinner.getInstance();\n```\n\nThis will return a singleton instance for the `Spinner` class.\n\n```typescript\nawait spinner.start(text: string);\n```\n\nThis will start a spinner with the given text.\n\n```typescript\nawait spinner.stop();\n```\n\nThis will stop the spinner and clears the line.\n\n```typescript\nspinner.setText(text: string);\n```\n\nUpdates the `text` shown with the spinner.\n\n```typescript\nspinner.setSpinnerType(type: string);\n```\n\n- This is used to update the spinner type\n- The detault spinner type is `dots2`\n- To see list of all available spinner types please refer [here](https://github.com/ameerthehacker/deno-cli-spinner/blob/master/spinners.ts)\n\n```typescript\nawait spinner.succeed([text]: string);\n```\n\nStop the spinner, change it to a green `✔` and persist the current text, or `text` if provided.\n\n```typescript\nawait spinner.fail([text]: string);\n```\n\nStop the spinner, change it to a red `✖` and persist the current text, or `text` if provided.\n\n```typescript\nawait spinner.warn([text]: string)\n```\n\nStop the spinner, change it to a yellow `⚠` and persist the current text, or `text` if provided.\n\n```typescript\nawait spinner.info([text]: string)\n```\n\nStop the spinner, change it to a blue `ℹ` and persist the current text, or `text` if provided.\n\n```typescript\nawait spinner.isRunning();\n```\n\nReturns true if the spinner is running.\n\n## License\n\nMIT © [Ameer Jhan](mailto:ameerjhanprof@gmail.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fameerthehacker%2Fdeno-cli-spinners","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fameerthehacker%2Fdeno-cli-spinners","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fameerthehacker%2Fdeno-cli-spinners/lists"}