• README

• Top Level Namespace
• Tiny
  • ParamParser
  • Request
    • Method
  • Response
  • Server

class Tiny::Response

• Tiny::Response
• Reference
• Object

Overview

A facade which sits in front of HTTP::Server::Response, providing a few helper methods. The object is passed into the block of Tiny's serve method.

serve do |request, response|
  # Return text to the client
  response.send "Unicorns!"

  # Return text with a specific status code
  response.send 500, "An error occurred"

  # Return a JSON object
  response.json {
    "testing" => "test"
  }
end

Defined in:

Constructors

• .new(context : HTTP::Server::Context)

  Create the response object

Instance Method Summary

• #allow_header(header : String)

  Set the Access-Control-Allow-Headers header

• #allow_origin(hostname : String?)

  Set the Access-Control-Allow-Origin header

• #allowed_headers : Array(String)

  A list of allowed headers for CORS purposes

• #error(code : Int32, message : String)

  Send an error response with a specific status code

• #error(message : String)

  Send an error response with a 500 status code

• #json(code : Int32, object : JSON::Type)

  Send a JSON response with a specific status code

• #json(object : JSON::Type)

  Send a JSON response with a 200 status code

• #request_methods(methods : Array(String))

  Set the Access-Control-Request-Method header

• #send(code : Int32)

  Send an empty response with a specific status code

• #send(code : Int32, *message : String)

  Send a response with a 200 status code

• #send(*message : String)

  Send a response with a 200 status code

Macro Summary

• method_missing(call)

  Cascade missing methods down to the server response

Constructor Detail

Instance Method Detail

response.allow_origin "example.com"

response.error 403, "Something happened"

response.error "Something happened"

response.json 500, {
  "error": "Something happened"
}

response.json {
  "rainbows": "unicorns"
}

response.request_methods ["GET", "POST"]

response.send 200

response.send 403, "You're not allowed to do that"

response.send 403,
  "Oh, crumbs!",
  "You're not allowed to do that"

response.send "Tada!"

response.send
  "First Line",
  "Second Line",
  "Third Line"

Macro Detail