Options
All
  • Public
  • Public/Protected
  • All
Menu

elm-tailwind-modules

Index

Variables

Const defaultTailwindConfig

defaultTailwindConfig: any = ...

Const docs

docs: __module = ...

Functions

asPostcssPlugin

  • asPostcssPlugin(__namedParameters: { generateDocumentation: boolean | documentation.DocumentationGenerator; logFunction: LogFunction; moduleName: string; modulesGeneratedHook: ModulesGeneratedHook; tailwindConfig: any }): { postcssPlugin: string; OnceExit: any }
  • This exposes the actual postcss plugin that's used in run.

    Parameters

    • __namedParameters: { generateDocumentation: boolean | documentation.DocumentationGenerator; logFunction: LogFunction; moduleName: string; modulesGeneratedHook: ModulesGeneratedHook; tailwindConfig: any }
      • generateDocumentation: boolean | documentation.DocumentationGenerator
      • logFunction: LogFunction
      • moduleName: string
      • modulesGeneratedHook: ModulesGeneratedHook

        a callback which is called once the modules have been generated.

      • tailwindConfig: any

    Returns { postcssPlugin: string; OnceExit: any }

    • postcssPlugin: string
    • OnceExit: function
      • OnceExit(root: default): Promise<void>
      • Parameters

        • root: default

        Returns Promise<void>

run

  • Runs elm-tailwind-modules like the command line interface is run.

    Parameters

    Returns Promise<RunResult>

    the generated modules as string.

writeGeneratedFiles

  • writeGeneratedFiles(__namedParameters: { directory: string; generated: { breakpointsModule: string; utilitiesModule: string }; logFunction: LogFunction; moduleName: string }): Promise<void>
  • This exposes the actual logic for writing files and writing some console output that is used in run (in the callback to asPostcssPlugin).

    Parameters

    • __namedParameters: { directory: string; generated: { breakpointsModule: string; utilitiesModule: string }; logFunction: LogFunction; moduleName: string }
      • directory: string
      • generated: { breakpointsModule: string; utilitiesModule: string }
        • breakpointsModule: string
        • utilitiesModule: string
      • logFunction: LogFunction
      • moduleName: string

    Returns Promise<void>

Generated using TypeDoc