Rest-1.0 ▶ Rest ▶ Param

constructor

• new Param(
      name: string,
      use: Rest.MemoryUse,
      data: string | Uint8Array<ArrayBufferLike>,
      content_type: string,
      filename?: string,
  ): Param

  Parameters

  • name: string
  • use: Rest.MemoryUse
  • data: string | Uint8Array<ArrayBufferLike>
  • content_type: string
  • Optionalfilename: string

  Returns Param

Static$gtype

get_content

• get_content(): any

  Get the content of param. The content should be treated as read-only and not modified in any way.

  Returns any

  the content.

get_content_length

• get_content_length(): number

  Get the length of the content of param.

  Returns number

  the length of the content

get_content_type

• get_content_type(): string

  Get the MIME type of the parameter. For example, basic strings have the MIME type "text/plain".

  Returns string

  the MIME type

get_file_name

• get_file_name(): string

  Get the original file name of the parameter, if one is available.

  Returns string

  the filename if set, or null.

get_name

• get_name(): string

  Get the name of the parameter.

  Returns string

  the parameter name.

is_string

• is_string(): boolean

  Determine if the parameter is a string value, i.e. the content type is "text/plain".

  Returns boolean

  true if the parameter is a string, false otherwise.

ref

• ref(): Param

  Increase the reference count on param.

  Returns Param

  the Rest.Param

unref

• unref(): void

  Decrease the reference count on param, destroying it if the reference count reaches 0.

  Returns void

Staticnew_full

• new_full(
      name: string,
      use: Rest.MemoryUse,
      data: string | Uint8Array<ArrayBufferLike>,
      content_type: string,
      filename?: string,
  ): Param

  Parameters

  • name: string
  • use: Rest.MemoryUse
  • data: string | Uint8Array<ArrayBufferLike>
  • content_type: string
  • Optionalfilename: string

  Returns Param

Staticnew_string

• new_string(name: string, use: Rest.MemoryUse, string: string): Param

  Parameters

  • name: string
  • use: Rest.MemoryUse
  • string: string

  Returns Param

Staticnew_with_owner

• new_with_owner(
      name: string,
      data: string | Uint8Array<ArrayBufferLike>,
      content_type: string,
      filename?: string,
      owner?: any,
      owner_dnotify?: DestroyNotify,
  ): Param

  Parameters

  • name: string
  • data: string | Uint8Array<ArrayBufferLike>
  • content_type: string
  • Optionalfilename: string
  • Optionalowner: any
  • Optionalowner_dnotify: DestroyNotify

  Returns Param