@haxall/haxall
    Preparing search index...

    Class MimeType

    MimeType represents the parsed value of a Content-Type header per RFC 2045 section 5.1.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    type$

    Methods

    charset compare equals hash isImmutable isText mediaType noParams params subType toImmutable toStr trap typeof with echo forExt fromStr parseParams

    Constructors

    Properties

    type$: Type

    Methods

    • If a charset parameter is specified, then map it to the Charset instance, otherwise return Charset.utf8.

      Returns Charset

    • Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:

      this < that   =>  <0
      this == that  =>  0
      this > that   =>  >0

      This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang.

      Examples:

      3.compare(8)  =>  -1
      8.compare(3)  =>  1
      8.compare(8)  =>  0
      3 <=> 8       =>  -1  // shortcut for 3.compare(8)

      Parameters

      Returns number

    • Equality is based on the case insensitive mediaType and subType, and params (keys are case insensitive and values are case sensitive).

      Parameters

      Returns boolean

    • Hash code is derived from the mediaType, subType, and params hashes.

      Returns number

    • Return if this Obj is immutable and safe to share between threads:

      • an instance of a const class
      • the result of toImmutable on List, Map, or Buf
      • a Func object may or may not be immutable - see sys::Func.
      • other instances are assumed mutable and return false

      Returns boolean

    • Return if this mime type is known to be text. This includes all "text/*" mime types along with special cases like "application/json".

      Returns boolean

    • The primary media type always in lowercase:

      text/html  =>  text

      Returns string

    • Return an instance with this mediaType and subType, but strip any parameters.

      Returns MimeType

    • Additional parameters stored in case-insensitive map. If no parameters, then this is an empty map.

      text/html; charset=utf-8    =>  [charset:utf-8]
      text/html; charset="utf-8"  =>  [charset:utf-8]

      Returns Map<string, string>

    • The subtype always in lowercase:

      text/html  =>  html

      Returns string

    • Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:

      • if type is const, return this
      • if already an immutable List, Map, Buf, or Func return this
      • if a List, then attempt to perform a deep clone by calling toImmutable on all items
      • if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
      • some Funcs can be made immutable - see sys::Func
      • if a Buf create immutable copy, see sys::Buf
      • any other object throws NotImmutableErr

      Returns Readonly<this>

    • Encode as a MIME message according to RFC 822. This is always the exact same string passed to fromStr.

      Returns string

    • Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:

      a->x        a.trap("x", null)
      a->x()      a.trap("x", null)
      a->x = b    a.trap("x", [b])
      a->x(b)     a.trap("x", [b])
      a->x(b, c)  a.trap("x", [b, c])

      The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.

      Parameters

      Returns JsObj

    • Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

      Returns Type

    • This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.

      Parameters

      • f: (arg0: this) => void

      Returns this

    • Write x.toStr to standard output followed by newline. If x is null then print "null". If no argument is provided then print an empty line.

      Parameters

      Returns void

    • Map a case insensitive file extension to a MimeType. This mapping is configured via "etc/sys/ext2mime.props". If no mapping is available return null.

      Parameters

      • ext: string

      Returns MimeType

    • Parse from string format. If invalid format and checked is false return null, otherwise throw ParseErr. Parenthesis comments are treated as part of the value.

      Parameters

      • s: string
      • Optionalchecked: boolean
      • ...args: unknown[]

      Returns MimeType

    • Parse a set of attribute-value parameters where the values may be tokens or quoted-strings. The resulting map is case insensitive. If invalid format return null or raise ParseErr based on checked flag. Parenthesis comments are not supported. If a value pair is missing "= value", then the value is defaulted to "".

      Examples:

      a=b; c="d"       =>  ["a":"b", "c"="d"]
      foo=bar; secure  =>  ["foo":"bar", "secure":""]

      Parameters

      • s: string
      • Optionalchecked: boolean

      Returns Map<string, string>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods