KC's Workspace
    Preparing search index...

    Class LazyResult_<RootNode>

    A Promise proxy for the result of PostCSS transformations.

    A LazyResult instance is returned by Processor#process.

    const lazy = postcss([autoprefixer]).process(css)
    

    Type Parameters

    Implements

    Implemented by

    Index

    Constructors

    Properties

    catch: <TResult = never>(
        onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null,
    ) => Promise<Result_<RootNode> | TResult>

    Processes input CSS through synchronous and asynchronous plugins and calls onRejected for each error thrown in any plugin.

    It implements standard Promise API.

    postcss([autoprefixer]).process(css).then(result => {
    console.log(result.css)
    }).catch(error => {
    console.error(error)
    })

    Type Declaration

      • <TResult = never>(
            onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null,
        ): Promise<Result_<RootNode> | TResult>
      • Attaches a callback for only the rejection of the Promise.

        Type Parameters

        • TResult = never

        Parameters

        • Optionalonrejected: ((reason: any) => TResult | PromiseLike<TResult>) | null

          The callback to execute when the Promise is rejected.

        Returns Promise<Result_<RootNode> | TResult>

        A Promise for the completion of the callback.

    finally: (onfinally?: (() => void) | null) => Promise<Result_<RootNode>>

    Processes input CSS through synchronous and asynchronous plugins and calls onFinally on any error or when all plugins will finish work.

    It implements standard Promise API.

    postcss([autoprefixer]).process(css).finally(() => {
    console.log('processing ended')
    })

    Type Declaration

      • (onfinally?: (() => void) | null): Promise<Result_<RootNode>>
      • Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

        Parameters

        • Optionalonfinally: (() => void) | null

          The callback to execute when the Promise is settled (fulfilled or rejected).

        Returns Promise<Result_<RootNode>>

        A Promise for the completion of the callback.

    then: <TResult1 = Result_<RootNode>, TResult2 = never>(
        onfulfilled?:
            | ((value: Result_) => TResult1 | PromiseLike<TResult1>)
            | null,
        onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null,
    ) => Promise<TResult1 | TResult2>

    Processes input CSS through synchronous and asynchronous plugins and calls onFulfilled with a Result instance. If a plugin throws an error, the onRejected callback will be executed.

    It implements standard Promise API.

    postcss([autoprefixer]).process(css, { from: cssPath }).then(result => {
    console.log(result.css)
    })

    Type Declaration

      • <TResult1 = Result_<RootNode>, TResult2 = never>(
            onfulfilled?:
                | ((value: Result_) => TResult1 | PromiseLike<TResult1>)
                | null,
            onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null,
        ): Promise<TResult1 | TResult2>
      • Attaches callbacks for the resolution and/or rejection of the Promise.

        Type Parameters

        Parameters

        • Optionalonfulfilled: ((value: Result_) => TResult1 | PromiseLike<TResult1>) | null

          The callback to execute when the Promise is resolved.

        • Optionalonrejected: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null

          The callback to execute when the Promise is rejected.

        Returns Promise<TResult1 | TResult2>

        A Promise for the completion of which ever callback is executed.

    Accessors

    • get "[toStringTag]"(): string

      Returns the default string description of an object. Required to implement the Promise interface.

      Returns string

    • get content(): string

      An alias for the css property. Use it with syntaxes that generate non-CSS output.

      This property will only work with synchronous plugins. If the processor contains any asynchronous plugins it will throw an error.

      PostCSS runners should always use LazyResult#then.

      Returns string

    • get css(): string

      Processes input CSS through synchronous plugins, converts Root to a CSS string and returns Result#css.

      This property will only work with synchronous plugins. If the processor contains any asynchronous plugins it will throw an error.

      PostCSS runners should always use LazyResult#then.

      Returns string

    • get map(): SourceMap

      Processes input CSS through synchronous plugins and returns Result#map.

      This property will only work with synchronous plugins. If the processor contains any asynchronous plugins it will throw an error.

      PostCSS runners should always use LazyResult#then.

      Returns SourceMap

    • get messages(): Message[]

      Processes input CSS through synchronous plugins and returns Result#messages.

      This property will only work with synchronous plugins. If the processor contains any asynchronous plugins it will throw an error.

      PostCSS runners should always use LazyResult#then.

      Returns Message[]

    • get processor(): Processor_

      Returns a Processor instance, which will be used for CSS transformations.

      Returns Processor_

    • get root(): RootNode

      Processes input CSS through synchronous plugins and returns Result#root.

      This property will only work with synchronous plugins. If the processor contains any asynchronous plugins it will throw an error.

      PostCSS runners should always use LazyResult#then.

      Returns RootNode

    Methods

    • Alias for the LazyResult#css property.

      lazy + '' === lazy.css
      

      Returns string

      Output CSS.

    • Processes input CSS through synchronous plugins and calls Result#warnings.

      Returns Warning_[]

      Warnings from plugins.