effect-libreoffice-workspace
    Preparing search index...

    Hierarchy

    • {}
      • ConvertRequest
    Index

    Constructors

    • Parameters

      • _: never

      Returns ConvertRequest

    Properties

    _tag: "Convert"
    "~effect/rpc/Rpc": "~effect/rpc/Rpc"
    "~requires": never
    annotations: Context<never>
    defectSchema: Top
    errorSchema: typeof LibreOfficeError
    key: string
    middlewares: ReadonlySet<never>
    payloadSchema: Struct
    successSchema: Struct

    Methods

    • Add an annotation on the rpc.

      Type Parameters

      • I
      • S

      Parameters

      • tag: Key<I, S>
      • value: NoInfer<S>

      Returns Rpc<
          "Convert",
          Struct<
              {
                  filename: optional<String>;
                  input: Uint8Array;
                  options: Struct<
                      {
                          filterOptions: optional<String>;
                          image: optional<
                              Struct<
                                  {
                                      dpi: optional<Number>;
                                      height: optional<Number>;
                                      pageIndex: optional<Number>;
                                      width: optional<Number>;
                                  },
                              >,
                          >;
                          inputFormat: optional<
                              Literals<
                                  readonly [
                                      "doc",
                                      "docx",
                                      "xls",
                                      "xlsx",
                                      "ppt",
                                      "pptx",
                                      "odt",
                                      "ods",
                                      "odp",
                                      "odg",
                                      "odf",
                                      "rtf",
                                      "txt",
                                      "html",
                                      "htm",
                                      "csv",
                                      "xml",
                                      "epub",
                                      "pdf",
                                  ],
                              >,
                          >;
                          outputFormat: Literals<
                              readonly [
                                  "pdf",
                                  "docx",
                                  "doc",
                                  "odt",
                                  "rtf",
                                  "txt",
                                  "html",
                                  "xlsx",
                                  "xls",
                                  "ods",
                                  "csv",
                                  "pptx",
                                  "ppt",
                                  "odp",
                                  "png",
                                  "jpg",
                                  "svg",
                              ],
                          >;
                          password: optional<String>;
                          pdf: optional<
                              Struct<
                                  {
                                      pdfaLevel: optional<Literals<readonly [(...), (...), (...)]>>;
                                      quality: optional<Number>;
                                  },
                              >,
                          >;
                      },
                  >;
              },
          >,
          Struct<
              {
                  data: Uint8Array;
                  duration: Number;
                  filename: String;
                  mimeType: String;
              },
          >,
          typeof LibreOfficeError,
          never,
          never,
      >

    • Merge the annotations of the rpc with the provided annotations.

      Type Parameters

      • I

      Parameters

      • annotations: Context<I>

      Returns Rpc<
          "Convert",
          Struct<
              {
                  filename: optional<String>;
                  input: Uint8Array;
                  options: Struct<
                      {
                          filterOptions: optional<String>;
                          image: optional<
                              Struct<
                                  {
                                      dpi: optional<Number>;
                                      height: optional<Number>;
                                      pageIndex: optional<Number>;
                                      width: optional<Number>;
                                  },
                              >,
                          >;
                          inputFormat: optional<
                              Literals<
                                  readonly [
                                      "doc",
                                      "docx",
                                      "xls",
                                      "xlsx",
                                      "ppt",
                                      "pptx",
                                      "odt",
                                      "ods",
                                      "odp",
                                      "odg",
                                      "odf",
                                      "rtf",
                                      "txt",
                                      "html",
                                      "htm",
                                      "csv",
                                      "xml",
                                      "epub",
                                      "pdf",
                                  ],
                              >,
                          >;
                          outputFormat: Literals<
                              readonly [
                                  "pdf",
                                  "docx",
                                  "doc",
                                  "odt",
                                  "rtf",
                                  "txt",
                                  "html",
                                  "xlsx",
                                  "xls",
                                  "ods",
                                  "csv",
                                  "pptx",
                                  "ppt",
                                  "odp",
                                  "png",
                                  "jpg",
                                  "svg",
                              ],
                          >;
                          password: optional<String>;
                          pdf: optional<
                              Struct<
                                  {
                                      pdfaLevel: optional<Literals<readonly [(...), (...), (...)]>>;
                                      quality: optional<Number>;
                                  },
                              >,
                          >;
                      },
                  >;
              },
          >,
          Struct<
              {
                  data: Uint8Array;
                  duration: Number;
                  filename: String;
                  mimeType: String;
              },
          >,
          typeof LibreOfficeError,
          never,
          never,
      >

    • Add an RpcMiddleware to this procedure.

      Type Parameters

      • M extends AnyService

      Parameters

      • middleware: M

      Returns Rpc<
          "Convert",
          Struct<
              {
                  filename: optional<String>;
                  input: Uint8Array;
                  options: Struct<
                      {
                          filterOptions: optional<String>;
                          image: optional<
                              Struct<
                                  {
                                      dpi: optional<Number>;
                                      height: optional<Number>;
                                      pageIndex: optional<Number>;
                                      width: optional<Number>;
                                  },
                              >,
                          >;
                          inputFormat: optional<
                              Literals<
                                  readonly [
                                      "doc",
                                      "docx",
                                      "xls",
                                      "xlsx",
                                      "ppt",
                                      "pptx",
                                      "odt",
                                      "ods",
                                      "odp",
                                      "odg",
                                      "odf",
                                      "rtf",
                                      "txt",
                                      "html",
                                      "htm",
                                      "csv",
                                      "xml",
                                      "epub",
                                      "pdf",
                                  ],
                              >,
                          >;
                          outputFormat: Literals<
                              readonly [
                                  "pdf",
                                  "docx",
                                  "doc",
                                  "odt",
                                  "rtf",
                                  "txt",
                                  "html",
                                  "xlsx",
                                  "xls",
                                  "ods",
                                  "csv",
                                  "pptx",
                                  "ppt",
                                  "odp",
                                  "png",
                                  "jpg",
                                  "svg",
                              ],
                          >;
                          password: optional<String>;
                          pdf: optional<
                              Struct<
                                  {
                                      pdfaLevel: optional<Literals<readonly [(...), (...), (...)]>>;
                                      quality: optional<Number>;
                                  },
                              >,
                          >;
                      },
                  >;
              },
          >,
          Struct<
              {
                  data: Uint8Array;
                  duration: Number;
                  filename: String;
                  mimeType: String;
              },
          >,
          typeof LibreOfficeError,
          M,
          Requires<M["Identifier"]>,
      >

    • Type Parameters

      • A

      Parameters

      • this: A

      Returns A

    • Type Parameters

      • A
      • B = never

      Parameters

      • this: A
      • ab: (_: A) => B

      Returns B

    • Type Parameters

      • A
      • B = never
      • C = never

      Parameters

      • this: A
      • ab: (_: A) => B
      • bc: (_: B) => C

      Returns C

    • Type Parameters

      • A
      • B = never
      • C = never
      • D = never

      Parameters

      • this: A
      • ab: (_: A) => B
      • bc: (_: B) => C
      • cd: (_: C) => D

      Returns D

    • Type Parameters

      • A
      • B = never
      • C = never
      • D = never
      • E = never

      Parameters

      • this: A
      • ab: (_: A) => B
      • bc: (_: B) => C
      • cd: (_: C) => D
      • de: (_: D) => E

      Returns E

    • Type Parameters

      • A
      • B = never
      • C = never
      • D = never
      • E = never
      • F = never

      Parameters

      • this: A
      • ab: (_: A) => B
      • bc: (_: B) => C
      • cd: (_: C) => D
      • de: (_: D) => E
      • ef: (_: E) => F

      Returns F

    • Type Parameters

      • A
      • B = never
      • C = never
      • D = never
      • E = never
      • F = never
      • G = never

      Parameters

      • this: A
      • ab: (_: A) => B
      • bc: (_: B) => C
      • cd: (_: C) => D
      • de: (_: D) => E
      • ef: (_: E) => F
      • fg: (_: F) => G

      Returns G

    • Type Parameters

      • A
      • B = never
      • C = never
      • D = never
      • E = never
      • F = never
      • G = never
      • H = never

      Parameters

      • this: A
      • ab: (_: A) => B
      • bc: (_: B) => C
      • cd: (_: C) => D
      • de: (_: D) => E
      • ef: (_: E) => F
      • fg: (_: F) => G
      • gh: (_: G) => H

      Returns H

    • Type Parameters

      • A
      • B = never
      • C = never
      • D = never
      • E = never
      • F = never
      • G = never
      • H = never
      • I = never

      Parameters

      • this: A
      • ab: (_: A) => B
      • bc: (_: B) => C
      • cd: (_: C) => D
      • de: (_: D) => E
      • ef: (_: E) => F
      • fg: (_: F) => G
      • gh: (_: G) => H
      • hi: (_: H) => I

      Returns I

    • Type Parameters

      • A
      • B = never
      • C = never
      • D = never
      • E = never
      • F = never
      • G = never
      • H = never
      • I = never
      • J = never

      Parameters

      • this: A
      • ab: (_: A) => B
      • bc: (_: B) => C
      • cd: (_: C) => D
      • de: (_: D) => E
      • ef: (_: E) => F
      • fg: (_: F) => G
      • gh: (_: G) => H
      • hi: (_: H) => I
      • ij: (_: I) => J

      Returns J

    • Type Parameters

      • A
      • B = never
      • C = never
      • D = never
      • E = never
      • F = never
      • G = never
      • H = never
      • I = never
      • J = never
      • K = never

      Parameters

      • this: A
      • ab: (_: A) => B
      • bc: (_: B) => C
      • cd: (_: C) => D
      • de: (_: D) => E
      • ef: (_: E) => F
      • fg: (_: F) => G
      • gh: (_: G) => H
      • hi: (_: H) => I
      • ij: (_: I) => J
      • jk: (_: J) => K

      Returns K

    • Type Parameters

      • A
      • B = never
      • C = never
      • D = never
      • E = never
      • F = never
      • G = never
      • H = never
      • I = never
      • J = never
      • K = never
      • L = never

      Parameters

      • this: A
      • ab: (_: A) => B
      • bc: (_: B) => C
      • cd: (_: C) => D
      • de: (_: D) => E
      • ef: (_: E) => F
      • fg: (_: F) => G
      • gh: (_: G) => H
      • hi: (_: H) => I
      • ij: (_: I) => J
      • jk: (_: J) => K
      • kl: (_: K) => L

      Returns L

    • Type Parameters

      • A
      • B = never
      • C = never
      • D = never
      • E = never
      • F = never
      • G = never
      • H = never
      • I = never
      • J = never
      • K = never
      • L = never
      • M = never

      Parameters

      • this: A
      • ab: (_: A) => B
      • bc: (_: B) => C
      • cd: (_: C) => D
      • de: (_: D) => E
      • ef: (_: E) => F
      • fg: (_: F) => G
      • gh: (_: G) => H
      • hi: (_: H) => I
      • ij: (_: I) => J
      • jk: (_: J) => K
      • kl: (_: K) => L
      • lm: (_: L) => M

      Returns M

    • Type Parameters

      • A
      • B = never
      • C = never
      • D = never
      • E = never
      • F = never
      • G = never
      • H = never
      • I = never
      • J = never
      • K = never
      • L = never
      • M = never
      • N = never

      Parameters

      • this: A
      • ab: (_: A) => B
      • bc: (_: B) => C
      • cd: (_: C) => D
      • de: (_: D) => E
      • ef: (_: E) => F
      • fg: (_: F) => G
      • gh: (_: G) => H
      • hi: (_: H) => I
      • ij: (_: I) => J
      • jk: (_: J) => K
      • kl: (_: K) => L
      • lm: (_: L) => M
      • mn: (_: M) => N

      Returns N

    • Type Parameters

      • A
      • B = never
      • C = never
      • D = never
      • E = never
      • F = never
      • G = never
      • H = never
      • I = never
      • J = never
      • K = never
      • L = never
      • M = never
      • N = never
      • O = never

      Parameters

      • this: A
      • ab: (_: A) => B
      • bc: (_: B) => C
      • cd: (_: C) => D
      • de: (_: D) => E
      • ef: (_: E) => F
      • fg: (_: F) => G
      • gh: (_: G) => H
      • hi: (_: H) => I
      • ij: (_: I) => J
      • jk: (_: J) => K
      • kl: (_: K) => L
      • lm: (_: L) => M
      • mn: (_: M) => N
      • no: (_: N) => O

      Returns O

    • Type Parameters

      • A
      • B = never
      • C = never
      • D = never
      • E = never
      • F = never
      • G = never
      • H = never
      • I = never
      • J = never
      • K = never
      • L = never
      • M = never
      • N = never
      • O = never
      • P = never

      Parameters

      • this: A
      • ab: (_: A) => B
      • bc: (_: B) => C
      • cd: (_: C) => D
      • de: (_: D) => E
      • ef: (_: E) => F
      • fg: (_: F) => G
      • gh: (_: G) => H
      • hi: (_: H) => I
      • ij: (_: I) => J
      • jk: (_: J) => K
      • kl: (_: K) => L
      • lm: (_: L) => M
      • mn: (_: M) => N
      • no: (_: N) => O
      • op: (_: O) => P

      Returns P

    • Type Parameters

      • A
      • B = never
      • C = never
      • D = never
      • E = never
      • F = never
      • G = never
      • H = never
      • I = never
      • J = never
      • K = never
      • L = never
      • M = never
      • N = never
      • O = never
      • P = never
      • Q = never

      Parameters

      • this: A
      • ab: (_: A) => B
      • bc: (_: B) => C
      • cd: (_: C) => D
      • de: (_: D) => E
      • ef: (_: E) => F
      • fg: (_: F) => G
      • gh: (_: G) => H
      • hi: (_: H) => I
      • ij: (_: I) => J
      • jk: (_: J) => K
      • kl: (_: K) => L
      • lm: (_: L) => M
      • mn: (_: M) => N
      • no: (_: N) => O
      • op: (_: O) => P
      • pq: (_: P) => Q

      Returns Q

    • Type Parameters

      • A
      • B = never
      • C = never
      • D = never
      • E = never
      • F = never
      • G = never
      • H = never
      • I = never
      • J = never
      • K = never
      • L = never
      • M = never
      • N = never
      • O = never
      • P = never
      • Q = never
      • R = never

      Parameters

      • this: A
      • ab: (_: A) => B
      • bc: (_: B) => C
      • cd: (_: C) => D
      • de: (_: D) => E
      • ef: (_: E) => F
      • fg: (_: F) => G
      • gh: (_: G) => H
      • hi: (_: H) => I
      • ij: (_: I) => J
      • jk: (_: J) => K
      • kl: (_: K) => L
      • lm: (_: L) => M
      • mn: (_: M) => N
      • no: (_: N) => O
      • op: (_: O) => P
      • pq: (_: P) => Q
      • qr: (_: Q) => R

      Returns R

    • Type Parameters

      • A
      • B = never
      • C = never
      • D = never
      • E = never
      • F = never
      • G = never
      • H = never
      • I = never
      • J = never
      • K = never
      • L = never
      • M = never
      • N = never
      • O = never
      • P = never
      • Q = never
      • R = never
      • S = never

      Parameters

      • this: A
      • ab: (_: A) => B
      • bc: (_: B) => C
      • cd: (_: C) => D
      • de: (_: D) => E
      • ef: (_: E) => F
      • fg: (_: F) => G
      • gh: (_: G) => H
      • hi: (_: H) => I
      • ij: (_: I) => J
      • jk: (_: J) => K
      • kl: (_: K) => L
      • lm: (_: L) => M
      • mn: (_: M) => N
      • no: (_: N) => O
      • op: (_: O) => P
      • pq: (_: P) => Q
      • qr: (_: Q) => R
      • rs: (_: R) => S

      Returns S

    • Type Parameters

      • A
      • B = never
      • C = never
      • D = never
      • E = never
      • F = never
      • G = never
      • H = never
      • I = never
      • J = never
      • K = never
      • L = never
      • M = never
      • N = never
      • O = never
      • P = never
      • Q = never
      • R = never
      • S = never
      • T = never

      Parameters

      • this: A
      • ab: (_: A) => B
      • bc: (_: B) => C
      • cd: (_: C) => D
      • de: (_: D) => E
      • ef: (_: E) => F
      • fg: (_: F) => G
      • gh: (_: G) => H
      • hi: (_: H) => I
      • ij: (_: I) => J
      • jk: (_: J) => K
      • kl: (_: K) => L
      • lm: (_: L) => M
      • mn: (_: M) => N
      • no: (_: N) => O
      • op: (_: O) => P
      • pq: (_: P) => Q
      • qr: (_: Q) => R
      • rs: (_: R) => S
      • st: (_: S) => T

      Returns T

    • Type Parameters

      • A
      • B = never
      • C = never
      • D = never
      • E = never
      • F = never
      • G = never
      • H = never
      • I = never
      • J = never
      • K = never
      • L = never
      • M = never
      • N = never
      • O = never
      • P = never
      • Q = never
      • R = never
      • S = never
      • T = never
      • U = never

      Parameters

      • this: A
      • ab: (_: A) => B
      • bc: (_: B) => C
      • cd: (_: C) => D
      • de: (_: D) => E
      • ef: (_: E) => F
      • fg: (_: F) => G
      • gh: (_: G) => H
      • hi: (_: H) => I
      • ij: (_: I) => J
      • jk: (_: J) => K
      • kl: (_: K) => L
      • lm: (_: L) => M
      • mn: (_: M) => N
      • no: (_: N) => O
      • op: (_: O) => P
      • pq: (_: P) => Q
      • qr: (_: Q) => R
      • rs: (_: R) => S
      • st: (_: S) => T
      • tu: (_: T) => U

      Returns U

    • Type Parameters

      • A
      • B = never
      • C = never
      • D = never
      • E = never
      • F = never
      • G = never
      • H = never
      • I = never
      • J = never
      • K = never
      • L = never
      • M = never
      • N = never
      • O = never
      • P = never
      • Q = never
      • R = never
      • S = never
      • T = never
      • U = never

      Parameters

      • this: A
      • ab: (_: A) => B
      • bc: (_: B) => C
      • cd: (_: C) => D
      • de: (_: D) => E
      • ef: (_: E) => F
      • fg: (_: F) => G
      • gh: (_: G) => H
      • hi: (_: H) => I
      • ij: (_: I) => J
      • jk: (_: J) => K
      • kl: (_: K) => L
      • lm: (_: L) => M
      • mn: (_: M) => N
      • no: (_: N) => O
      • op: (_: O) => P
      • pq: (_: P) => Q
      • qr: (_: Q) => R
      • rs: (_: R) => S
      • st: (_: S) => T
      • tu: (_: T) => U

      Returns U

    • Set the schema for the error response of the rpc.

      Type Parameters

      • const Prefix extends string

      Parameters

      Returns Rpc<
          `${Prefix}Convert`,
          Struct<
              {
                  filename: optional<String>;
                  input: Uint8Array;
                  options: Struct<
                      {
                          filterOptions: optional<String>;
                          image: optional<
                              Struct<
                                  {
                                      dpi: optional<Number>;
                                      height: optional<Number>;
                                      pageIndex: optional<Number>;
                                      width: optional<Number>;
                                  },
                              >,
                          >;
                          inputFormat: optional<
                              Literals<
                                  readonly [
                                      "doc",
                                      "docx",
                                      "xls",
                                      "xlsx",
                                      "ppt",
                                      "pptx",
                                      "odt",
                                      "ods",
                                      "odp",
                                      "odg",
                                      "odf",
                                      "rtf",
                                      "txt",
                                      "html",
                                      "htm",
                                      "csv",
                                      "xml",
                                      "epub",
                                      "pdf",
                                  ],
                              >,
                          >;
                          outputFormat: Literals<
                              readonly [
                                  "pdf",
                                  "docx",
                                  "doc",
                                  "odt",
                                  "rtf",
                                  "txt",
                                  "html",
                                  "xlsx",
                                  "xls",
                                  "ods",
                                  "csv",
                                  "pptx",
                                  "ppt",
                                  "odp",
                                  "png",
                                  "jpg",
                                  "svg",
                              ],
                          >;
                          password: optional<String>;
                          pdf: optional<
                              Struct<
                                  {
                                      pdfaLevel: optional<Literals<readonly [(...), (...), (...)]>>;
                                      quality: optional<Number>;
                                  },
                              >,
                          >;
                      },
                  >;
              },
          >,
          Struct<
              {
                  data: Uint8Array;
                  duration: Number;
                  filename: String;
                  mimeType: String;
              },
          >,
          typeof LibreOfficeError,
          never,
          never,
      >

    • Set the schema for the error response of the rpc.

      Type Parameters

      • E extends Top

      Parameters

      • schema: E

      Returns Rpc<
          "Convert",
          Struct<
              {
                  filename: optional<String>;
                  input: Uint8Array;
                  options: Struct<
                      {
                          filterOptions: optional<String>;
                          image: optional<
                              Struct<
                                  {
                                      dpi: optional<Number>;
                                      height: optional<Number>;
                                      pageIndex: optional<Number>;
                                      width: optional<Number>;
                                  },
                              >,
                          >;
                          inputFormat: optional<
                              Literals<
                                  readonly [
                                      "doc",
                                      "docx",
                                      "xls",
                                      "xlsx",
                                      "ppt",
                                      "pptx",
                                      "odt",
                                      "ods",
                                      "odp",
                                      "odg",
                                      "odf",
                                      "rtf",
                                      "txt",
                                      "html",
                                      "htm",
                                      "csv",
                                      "xml",
                                      "epub",
                                      "pdf",
                                  ],
                              >,
                          >;
                          outputFormat: Literals<
                              readonly [
                                  "pdf",
                                  "docx",
                                  "doc",
                                  "odt",
                                  "rtf",
                                  "txt",
                                  "html",
                                  "xlsx",
                                  "xls",
                                  "ods",
                                  "csv",
                                  "pptx",
                                  "ppt",
                                  "odp",
                                  "png",
                                  "jpg",
                                  "svg",
                              ],
                          >;
                          password: optional<String>;
                          pdf: optional<
                              Struct<
                                  {
                                      pdfaLevel: optional<Literals<readonly [(...), (...), (...)]>>;
                                      quality: optional<Number>;
                                  },
                              >,
                          >;
                      },
                  >;
              },
          >,
          Struct<
              {
                  data: Uint8Array;
                  duration: Number;
                  filename: String;
                  mimeType: String;
              },
          >,
          E,
          never,
          never,
      >

    • Set the schema for the payload of the rpc.

      Type Parameters

      • P extends Fields | Top

      Parameters

      • schema: P

      Returns Rpc<
          "Convert",
          P extends Fields ? Struct<P> : P,
          Struct<
              {
                  data: Uint8Array;
                  duration: Number;
                  filename: String;
                  mimeType: String;
              },
          >,
          typeof LibreOfficeError,
          never,
          never,
      >

    • Set the schema for the success response of the rpc.

      Type Parameters

      • S extends Top

      Parameters

      • schema: S

      Returns Rpc<
          "Convert",
          Struct<
              {
                  filename: optional<String>;
                  input: Uint8Array;
                  options: Struct<
                      {
                          filterOptions: optional<String>;
                          image: optional<
                              Struct<
                                  {
                                      dpi: optional<Number>;
                                      height: optional<Number>;
                                      pageIndex: optional<Number>;
                                      width: optional<Number>;
                                  },
                              >,
                          >;
                          inputFormat: optional<
                              Literals<
                                  readonly [
                                      "doc",
                                      "docx",
                                      "xls",
                                      "xlsx",
                                      "ppt",
                                      "pptx",
                                      "odt",
                                      "ods",
                                      "odp",
                                      "odg",
                                      "odf",
                                      "rtf",
                                      "txt",
                                      "html",
                                      "htm",
                                      "csv",
                                      "xml",
                                      "epub",
                                      "pdf",
                                  ],
                              >,
                          >;
                          outputFormat: Literals<
                              readonly [
                                  "pdf",
                                  "docx",
                                  "doc",
                                  "odt",
                                  "rtf",
                                  "txt",
                                  "html",
                                  "xlsx",
                                  "xls",
                                  "ods",
                                  "csv",
                                  "pptx",
                                  "ppt",
                                  "odp",
                                  "png",
                                  "jpg",
                                  "svg",
                              ],
                          >;
                          password: optional<String>;
                          pdf: optional<
                              Struct<
                                  {
                                      pdfaLevel: optional<Literals<readonly [(...), (...), (...)]>>;
                                      quality: optional<Number>;
                                  },
                              >,
                          >;
                      },
                  >;
              },
          >,
          S,
          typeof LibreOfficeError,
          never,
          never,
      >