Handler that sets CORS options on the response. In case of an OPTIONS request this handler will close the connection after adding its headers if preflightContinue is set to false.

Solid, §8.1: "A server MUST implement the CORS protocol [FETCH] such that, to the extent possible, the browser allows Solid apps to send any request and combination of request headers to the server, and the Solid app can read any response and response headers received from the server." Full details: https://solidproject.org/TR/2021/protocol-20211217#cors-server

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

corsHandler: ((req, res, next) => void)

Type declaration

    • (req, res, next): void
    • Parameters

      • req: CorsRequest
      • res: {
            end: (() => any);
            setHeader: ((key, value) => any);
            statusCode?: number;
        }
        • end: (() => any)
            • (): any
            • Returns any

        • setHeader: ((key, value) => any)
            • (key, value): any
            • Parameters

              • key: string
              • value: string

              Returns any

        • Optional statusCode?: number
      • next: ((err?) => any)
          • (err?): any
          • Parameters

            • Optional err: any

            Returns any

      Returns void

Methods

  • Checks if the input can be handled by this class. If it cannot handle the input, rejects with an error explaining why.

    Parameters

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.