@types/nprogress

  • Version 0.2.3
  • Published
  • 4.83 kB
  • No dependencies
  • MIT license

Install

npm i @types/nprogress
yarn add @types/nprogress
pnpm add @types/nprogress

Overview

TypeScript definitions for nprogress

Index

Variables

variable nProgress

const nProgress: nProgress.NProgress;

    Interfaces

    interface NProgress

    interface NProgress {}

      property settings

      settings: NProgressOptions;

        property status

        status: number | null;

          property version

          version: string;

            method configure

            configure: (options: Partial<NProgressOptions>) => NProgress;

              method done

              done: (force?: boolean) => NProgress;

                method getPositioningCSS

                getPositioningCSS: () => 'translate3d' | 'translate' | 'margin';

                  method inc

                  inc: (amount?: number) => NProgress;

                    method isRendered

                    isRendered: () => boolean;

                      method isStarted

                      isStarted: () => boolean;

                        method remove

                        remove: () => void;

                          method render

                          render: (fromStart?: boolean) => HTMLDivElement;

                            method set

                            set: (number: number) => NProgress;

                              method start

                              start: () => NProgress;

                                method trickle

                                trickle: () => NProgress;

                                  interface NProgressOptions

                                  interface NProgressOptions {}

                                    property barSelector

                                    barSelector: string;

                                      property easing

                                      easing: string;

                                        property minimum

                                        minimum: number;

                                          property parent

                                          parent: string;

                                            property positionUsing

                                            positionUsing: string;

                                              property showSpinner

                                              showSpinner: boolean;

                                                property speed

                                                speed: number;

                                                  property spinnerSelector

                                                  spinnerSelector: string;

                                                    property template

                                                    template: string;

                                                      property trickle

                                                      trickle: boolean;

                                                        property trickleSpeed

                                                        trickleSpeed: number;

                                                          Package Files (1)

                                                          Dependencies (0)

                                                          No dependencies.

                                                          Dev Dependencies (0)

                                                          No dev dependencies.

                                                          Peer Dependencies (0)

                                                          No peer dependencies.

                                                          Badge

                                                          To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                          You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/nprogress.

                                                          • Markdown
                                                            [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/nprogress)
                                                          • HTML
                                                            <a href="https://www.jsdocs.io/package/@types/nprogress"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>