Class Input_

constructor

• new Input_(css: string, opts?: ProcessOptions<Document_ | Root_>): Input_

  Parameters

  • css: string

    Input CSS source.

  • Optionalopts: ProcessOptions<Document_ | Root_>

    Process options.

  Returns Input_

css

const input = postcss.parse('a{}', { from: file }).input
input.css //=> "a{}"
Copy

document

const input = postcss.parse('a{}', { from: file, document: '<style>a {}</style>' }).input
input.document //=> "<style>a {}</style>"
input.css //=> "a{}"
Copy

Optionalfile

const root = postcss.parse(css, { from: 'a.css' })
root.source.input.file //=> '/home/ai/a.css'
Copy

hasBOM

Optionalid

const root = postcss.parse(css)
root.source.input.file //=> undefined
root.source.input.id   //=> "<input css 8LZeVF>"
Copy

map

root.source.input.map.consumer().sources //=> ['a.sass']
Copy

from

• get from(): string

  The CSS source identifier. Contains Input#file if the user set the from option, or Input#id if they did not.

  const root = postcss.parse(css, { from: 'a.css' })
  root.source.input.from //=> "/home/ai/a.css"
  
  const root = postcss.parse(css)
  root.source.input.from //=> "<input css 1>"
  Copy

  Returns string

error

• error(
      message: string,
      start: { column: number; line: number } | { offset: number },
      end: { column: number; line: number } | { offset: number },
      opts?: { plugin?: string },
  ): CssSyntaxError_

  Returns CssSyntaxError with information about the error and its position.

  Parameters

  • message: string
  • start: { column: number; line: number } | { offset: number }
  • end: { column: number; line: number } | { offset: number }
  • Optionalopts: { plugin?: string }

  Returns CssSyntaxError_

• error(
      message: string,
      line: number,
      column: number,
      opts?: { plugin?: string },
  ): CssSyntaxError_

  Returns CssSyntaxError with information about the error and its position.

  Parameters

  • message: string
  • line: number
  • column: number
  • Optionalopts: { plugin?: string }

  Returns CssSyntaxError_

• error(
      message: string,
      offset: number,
      opts?: { plugin?: string },
  ): CssSyntaxError_

  Returns CssSyntaxError with information about the error and its position.

  Parameters

  • message: string
  • offset: number
  • Optionalopts: { plugin?: string }

  Returns CssSyntaxError_

fromLineAndColumn

• fromLineAndColumn(line: number, column: number): number

  Converts source line and column to offset.

  Parameters

  • line: number

    Source line.

  • column: number

    Source column.

  Returns number

  Source offset.

fromOffset

• fromOffset(offset: number): { col: number; line: number } | null

  Converts source offset to line and column.

  Parameters

  • offset: number

    Source offset.

  Returns { col: number; line: number } | null

origin

• origin(
      line: number,
      column: number,
      endLine?: number,
      endColumn?: number,
  ): false | FilePosition

  Reads the input source map and returns a symbol position in the input source (e.g., in a Sass file that was compiled to CSS before being passed to PostCSS). Optionally takes an end position, exclusive.

  root.source.input.origin(1, 1) //=> { file: 'a.css', line: 3, column: 1 }
  root.source.input.origin(1, 1, 1, 4)
  //=> { file: 'a.css', line: 3, column: 1, endLine: 3, endColumn: 4 }
  Copy

  Parameters

  • line: number

    Line for inclusive start position in input CSS.

  • column: number

    Column for inclusive start position in input CSS.

  • OptionalendLine: number

    Line for exclusive end position in input CSS.

  • OptionalendColumn: number

    Column for exclusive end position in input CSS.

  Returns false | FilePosition

  Position in input source.

toJSON

• toJSON(): object

  Converts this to a JSON-friendly object representation.

  Returns object