webpack-sources

webpack-sources

Version 3.5.0
Published 8 days ago
164 kB
No dependencies
MIT license

Install

npm i webpack-sources

yarn add webpack-sources

pnpm add webpack-sources

Overview

Source code handling classes for webpack

Index

Type Aliases

ConcatSourceChild
OnChunk
OnName
OnSource
SourceValue

Namespaces

util
util.stringBufferUtils

Classes

class CachedSource

class CachedSource extends Source {}

constructor

constructor(source: Source | (() => Source), cachedData?: CachedData);

method getCachedData

getCachedData: () => CachedData;

method original

original: () => Source;

method originalLazy

originalLazy: () => Source | (() => Source);

method streamChunks

streamChunks: (
    options: StreamChunksOptions,
    onChunk: (
        chunk: undefined | string,
        generatedLine: number,
        generatedColumn: number,
        sourceIndex: number,
        originalLine: number,
        originalColumn: number,
        nameIndex: number
    ) => void,
    onSource: (
        sourceIndex: number,
        source: null | string,
        sourceContent?: string
    ) => void,
    onName: (nameIndex: number, name: string) => void
) => GeneratedSourceInfo;

class CompatSource

class CompatSource extends Source {}

constructor

constructor(sourceLike: SourceLike);

method from

static from: (sourceLike: SourceLike) => Source;

class ConcatSource

class ConcatSource extends Source {}

constructor

constructor(...args: ConcatSourceChild[]);

method add

add: (item: ConcatSourceChild) => void;

method addAllSkipOptimizing

addAllSkipOptimizing: (items: ConcatSourceChild[]) => void;

method getChildren

getChildren: () => Source[];

method streamChunks

streamChunks: (
    options: StreamChunksOptions,
    onChunk: (
        chunk: undefined | string,
        generatedLine: number,
        generatedColumn: number,
        sourceIndex: number,
        originalLine: number,
        originalColumn: number,
        nameIndex: number
    ) => void,
    onSource: (
        sourceIndex: number,
        source: null | string,
        sourceContent?: string
    ) => void,
    onName: (nameIndex: number, name: string) => void
) => GeneratedSourceInfo;

class OriginalSource

class OriginalSource extends Source {}

constructor

constructor(value: any, name: string);

method getName

getName: () => string;

method streamChunks

streamChunks: (
    options: StreamChunksOptions,
    onChunk: (
        chunk: undefined | string,
        generatedLine: number,
        generatedColumn: number,
        sourceIndex: number,
        originalLine: number,
        originalColumn: number,
        nameIndex: number
    ) => void,
    onSource: (
        sourceIndex: number,
        source: null | string,
        sourceContent?: string
    ) => void,
    _onName: (nameIndex: number, name: string) => void
) => GeneratedSourceInfo;

class PrefixSource

class PrefixSource extends Source {}

constructor

constructor(prefix: string, source: any);

method getPrefix

getPrefix: () => string;

method original

original: () => Source;

method streamChunks

streamChunks: (
    options: StreamChunksOptions,
    onChunk: (
        chunk: undefined | string,
        generatedLine: number,
        generatedColumn: number,
        sourceIndex: number,
        originalLine: number,
        originalColumn: number,
        nameIndex: number
    ) => void,
    onSource: (
        sourceIndex: number,
        source: null | string,
        sourceContent?: string
    ) => void,
    onName: (nameIndex: number, name: string) => void
) => GeneratedSourceInfo;

class RawSource

class RawSource extends Source {}

constructor

constructor(value: any, convertToString?: boolean);

method isBuffer

isBuffer: () => boolean;

method streamChunks

streamChunks: (
    options: StreamChunksOptions,
    onChunk: (
        chunk: undefined | string,
        generatedLine: number,
        generatedColumn: number,
        sourceIndex: number,
        originalLine: number,
        originalColumn: number,
        nameIndex: number
    ) => void,
    onSource: (
        sourceIndex: number,
        source: null | string,
        sourceContent?: string
    ) => void,
    onName: (nameIndex: number, name: string) => void
) => GeneratedSourceInfo;

class Replacement

class Replacement {}

constructor

constructor(start: number, end: number, content: string, name?: string);

property content

content: string;

property end

end: number;

property index

index?: number;

property name

name?: string;

property start

start: number;

class ReplaceSource

class ReplaceSource extends Source {}

constructor

constructor(source: Source, name?: string);

property Replacement

static Replacement: typeof Replacement;

method getName

getName: () => undefined | string;

method getReplacements

getReplacements: () => Replacement[];

method insert

insert: (pos: number, newValue: string, name?: string) => void;

method original

original: () => Source;

method replace

replace: (start: number, end: number, newValue: string, name?: string) => void;

method streamChunks

streamChunks: (
    options: StreamChunksOptions,
    onChunk: (
        chunk: undefined | string,
        generatedLine: number,
        generatedColumn: number,
        sourceIndex: number,
        originalLine: number,
        originalColumn: number,
        nameIndex: number
    ) => void,
    onSource: (
        sourceIndex: number,
        source: null | string,
        sourceContent?: string
    ) => void,
    onName: (nameIndex: number, name: string) => void
) => GeneratedSourceInfo;

class SizeOnlySource

class SizeOnlySource extends Source {}

constructor

constructor(size: number);

class Source

class Source {}

constructor

constructor();

method buffer

buffer: () => Buffer;

method buffers

buffers: () => Buffer[];

method clearCache

clearCache: (options?: ClearCacheOptions, visited?: WeakSet<Source>) => void;

Release cached data held by this source. clearCache is a memory hint: it never affects correctness or output, only how expensive the next read is. Subclasses override; the base is a no-op so every Source supports the call. Composite sources always recurse into wrapped sources. When the same child is reachable via several parents (e.g. modules shared across webpack chunks), pass a shared visited WeakSet so each subtree is walked at most once. Not safe to call concurrently with source/map/sourceAndMap/ streamChunks/updateHash on the same instance.

method map

map: (options?: MapOptions) => null | RawSourceMap;

method size

size: () => number;

method source

source: () => SourceValue;

method sourceAndMap

sourceAndMap: (options?: MapOptions) => SourceAndMap;

method updateHash

updateHash: (hash: HashLike) => void;

class SourceMapSource

class SourceMapSource extends Source {}

constructor

constructor(
    value: any,
    name: string,
    sourceMap?: any,
    originalSource?: any,
    innerSourceMap?: any,
    removeOriginalSource?: boolean
);

method getArgsAsBuffers

getArgsAsBuffers: () => [
    Buffer,
    string,
    Buffer,
    undefined | Buffer,
    undefined | Buffer,
    undefined | boolean
];

method streamChunks

streamChunks: (
    options: StreamChunksOptions,
    onChunk: (
        chunk: undefined | string,
        generatedLine: number,
        generatedColumn: number,
        sourceIndex: number,
        originalLine: number,
        originalColumn: number,
        nameIndex: number
    ) => void,
    onSource: (
        sourceIndex: number,
        source: null | string,
        sourceContent?: string
    ) => void,
    onName: (nameIndex: number, name: string) => void
) => GeneratedSourceInfo;

Interfaces

interface CachedData

interface CachedData {}

property buffer

buffer: Buffer;

buffer

property hash

hash?: (string | Buffer)[];

hash

property maps

maps: Map<string, BufferEntry>;

maps

property size

size?: number;

size

property source

source?: boolean;

source

interface GeneratedSourceInfo

interface GeneratedSourceInfo {}

property generatedColumn

generatedColumn?: number;

generated column

property generatedLine

generatedLine?: number;

generated line

property source

source?: string;

source

interface HashLike

interface HashLike {}

property digest

digest: (encoding?: string) => string | Buffer;

get hash digest

property update

update: (data: string | Buffer, inputEncoding?: string) => HashLike;

make hash update

interface MapOptions

interface MapOptions {}

property columns

columns?: boolean;

need columns?

property module

module?: boolean;

is module

interface RawSourceMap

interface RawSourceMap {}

property debugId

debugId?: string;

debug id

property file

file: string;

file

property ignoreList

ignoreList?: number[];

ignore list

property mappings

mappings: string;

mappings

property names

names: string[];

names

property sourceRoot

sourceRoot?: string;

source root

property sources

sources: string[];

sources

property sourcesContent

sourcesContent?: string[];

sources content

property version

version: number;

version

interface SourceAndMap

interface SourceAndMap {}

property map

map: null | RawSourceMap;

property source

source: SourceValue;

source

interface SourceLike

interface SourceLike {}

property buffer

buffer?: () => Buffer;

buffer

property buffers

buffers?: () => Buffer[];

buffers

property clearCache

clearCache?: (options?: ClearCacheOptions, visited?: WeakSet<Source>) => void;

clear cache

property map

map?: (options?: MapOptions) => null | RawSourceMap;

property size

size?: () => number;

size

property source

source: () => SourceValue;

source

property sourceAndMap

sourceAndMap?: (options?: MapOptions) => SourceAndMap;

source and map

property updateHash

updateHash?: (hash: HashLike) => void;

hash updater

interface StreamChunksOptions

interface StreamChunksOptions {}

property columns

columns?: boolean;

property finalSource

finalSource?: boolean;

property source

source?: boolean;

Type Aliases

type ConcatSourceChild

type ConcatSourceChild = string | Source | SourceLike;

type OnChunk

type OnChunk = (
    chunk: undefined | string,
    generatedLine: number,
    generatedColumn: number,
    sourceIndex: number,
    originalLine: number,
    originalColumn: number,
    nameIndex: number
) => void;

type OnName

type OnName = (nameIndex: number, name: string) => void;

type OnSource

type OnSource = (
    sourceIndex: number,
    source: null | string,
    sourceContent?: string
) => void;

type SourceValue

type SourceValue = string | Buffer;

Namespaces

namespace util

namespace util {}

namespace util.stringBufferUtils

namespace util.stringBufferUtils {}

function disableDualStringBufferCaching

disableDualStringBufferCaching: () => void;

function enableDualStringBufferCaching

enableDualStringBufferCaching: () => void;

function enterStringInterningRange

enterStringInterningRange: () => void;

function exitStringInterningRange

exitStringInterningRange: () => void;

function internString

internString: (str: string) => string;

function isDualStringBufferCachingEnabled

isDualStringBufferCachingEnabled: () => boolean;

Package Files (1)

types.d.ts

Dependencies (0)

No dependencies.

Dev Dependencies (15)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto 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/webpack-sources.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/webpack-sources)

HTML

<a href="https://www.jsdocs.io/package/webpack-sources"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 7 days ago.
Package analyzed in 4346 ms.
Missing or incorrect documentation? Open an issue for this package.