Skip to content

Deprecate internal functions exposed in the public API #123

@dduponchel

Description

@dduponchel

Currently, JSZip exposes a lot of internal functions :

JSZip.base64.decode
JSZip.base64.encode
JSZip.prototype.crc32
JSZip.prototype.utf8decode
JSZip.prototype.utf8encode

JSZip.utils.MAX_VALUE_16BITS
JSZip.utils.MAX_VALUE_32BITS
JSZip.utils.arrayBuffer2Blob
JSZip.utils.checkSupport
JSZip.utils.findCompression
JSZip.utils.getTypeOf
JSZip.utils.isRegExp
JSZip.utils.pretty
JSZip.utils.string2Blob
JSZip.utils.string2Uint8Array
JSZip.utils.string2binary
JSZip.utils.transformTo
JSZip.utils.uint8Array2String

These functions/objects are not documented and in my opinion not really useful outside JSZip. The base64/crc32/utf8 methods may have some uses for other people but their signatures are sometimes surprising (utf8encode takes a string and return a string for example).

I think we should deprecate the list above (keep them internally but flag their inclusion in the public API as deprecated).
Thoughts, anyone ?

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions