API - Document MultiStats

[donaldpipowitch]

"By accident" I found out about MultiStats today. Looks like neither the old nor the new docs mention MultiStats.

This actually broke my code when I switched from a normal compiler config to the multi compiler config, because I tried to access stats.compilation which is undefined on MultiStats (but not a normal Stats).

[skipjack]

@webpack/documentation-team any idea what's involved to get this documented? It seems the stats configuration page may need to updated and something would have to be added in the API docs? This is a part of webpack I'm not too familiar with but I'd be happy to help push this forward however I can.

@donaldpipowitch where do you think would be an appropriate place (or places) to add this documentation? Is there anywhere specific you were looking when you were trying to debug that issue?

[skipjack]

There's also this small section on the MultiCompiler.

[kevinbuhmann]

The @types/webpack type definitions also need updating.

[sokra]

The Stats object interface has only these methods:

toJson(opt)
toString(opt)
hasErrors()
hasWarnings()

The compilation property is private.

webpack either returns a Stats or a MultiStats which both fulfill this interface.

[skipjack]

Ok and those methods are all documented here. I'll just add a note about the MultiStats which I guess is returned when using the MultiCompiler. @donaldpipowitch so it seems the answer to your issue is really just that compilation is not meant to be accessed.

[donaldpipowitch]

Good to know, thank you all.

[kevinbuhmann]

Is the stats array on MultiStats supposed to be private also? https://github.com/webpack/webpack/blob/master/lib/MultiStats.js#L13

[skipjack]

@kevinphelps good question, @sokra? It seems maybe the private methods should be prefixed by an _ to prevent confusion?

[donaldpipowitch]

A _ prefix would be awesome.